You are on page 1of 47

Non-Protectively Marked

UK Government Gateway Document Submission Protocol

7.
01
r2
be
Government Gateway Document Submission

em
Protocol

ov
N
Name: GGTE011 2
on
Version: 3.1
Owner: enGage PMO Manager
n

Status: Baseline
aw

Security NON PROTECTIVELY MARKED
dr

Classification:
Date: 6th March 2008
ith
w
as
w
n
io
at

© Crown copyright 2008
lic

The text in this document may be reproduced free of charge in any
b

format or media without requiring specific permission. This is subject to
pu

the material not being used in a derogatory manner or in a misleading
context. The source of the material must be acknowledged as Crown
copyright and the title of the document must be included when being
is

reproduced as part of another publication or service.
Th

EDT (Delivery and Transformation Group), Cabinet Office
301 Bridgewater Place
Birchwood Park
Warrington
Cheshire, WA3 6XF

Version 3.1 Page 1 of 47 Published Date: 06/03/08

Non-Protectively Marked
UK Government Gateway Document Submission Protocol

Revision & Sign-Off Sheet
Change Record

Date Author Version Status Change Reference

19 Nov 2001 1.0 Baseline “Protocol States” section replaced.
References specific to 3 transactions removed'
References to GovTalk web site added.
URLs updated.
Use of ACKNOWLEDGE vs

7.
ACKNOWLEDGEMENT made consistent for

01
both submission and delete.
Mandatory Body elements added to

r2
SUBMISSION_ACKNOWLEDGEMENT and
DELETE_ACKNOWLEDGEMENT samples.

be
Ambiguous information clarified and missing
information added.

em
Numerous corrections.

ov
13 Mar 2002 1.1 Baseline Corrected URL references for submission point.

N
07 Feb 2003 Stefan 1.2 Baseline Corrected examples, optional SenderDetails
Delmarco
2
elements added.
Support GovTalk envelope version 2.0.
on
10 Mar 2003 Stefan 2.0 Baseline Corrected examples, GatewayTimeStamp
n

Delmarco element.
aw

Use of MUST/SHOULD replaced with
MANDATORY/OPTIONAL wording.
dr
ith

14 Apr 2003 Stefan 2.1 Baseline Clarified GatewayTimeStamp behaviour
Delmarco regarding GMT to BST and vice versa.
w

10 Jun 2003 Stefan 3.0 Baseline Minor formatting updates and document re-
as

Delmarco baselined for publishing.
w

28 Oct 2003 Alison 3.1 Baseline Cosmetic changes as requested by EDT
n

Menegaldo
io
at

30 Jul 2004 M. Gibson 5.0 Baseline References to non-customer facing documents
removed.
lic

Re-baselined at version 5 following rebranding.
b

No change to core text.
pu

21 Feb 2005 F. Price 6.0 Baseline Minor Cosmetic Changes. Re-versioned at 6.0,
is

no substantive changes to content.
Th

04 May 2005 A. 7.0 Baseline Correct section numbering.
Johnston

04 Nov 2005 A. 8.0 Baseline With release 1.6.6 of the Government Gateway
Johnston the DATA_RESPONSE message can now return
Identifiers for each outstanding submission. This
is achieved by including the new
IncludeIdentifiers element (with a value of “1”) in
the DATA__REQUEST message.

23 Feb 2006 M Pini 9.0 Baseline Updated for release 1.6.7 of the Government

Version 3.1 Page 2 of 47 Published Date: 06/03/08

Non-Protectively Marked
UK Government Gateway Document Submission Protocol

Gateway. Emails sent by the Gateway to notify a
user that a response has been received from a
service can now be disabled for each transaction
class.
Some clarifications added to document.

28 Feb 2007 M. Allen 1.0 Baseline Government Gateway Customer Document Set
standardisation.
Note: Version numbers reset to 1.0.

02 Mar 2007 M Pini 2.0 Baseline Document re-issued (without change) for release
Candidate 2.0 of the Gateway

7.
02 Jul 2007 M Pini 2.1 Baseline Updated to reflect rewrite of Gateway

01
Transactions Engine (which includes DSP) and

r2
to simplify/clarify documentation.

be
04 Sep 2007 M Pini 2.2 Baseline MR200-01 updates + corrections/clarification
Candidate identified by HMRC.

em
03 Oct 2007 M Pini 2.2 Baseline Full update history added to document.

ov
Document Published.

N
06 Aug 2007 M Pini 3.0 Baseline Document re-issued (without change) for release
Candidate 2.2 of the Gateway.
2
on
28 Nov 2007 M Pini 3.1 Baseline Updated for release 2.2 of the Gateway: support
Candidate for DRM Users.
n

In addtition the GovTalk Envelope schema is no
aw

longer included – instead a link to GovTalk
website is provided.
dr
ith

06 Mar 2008 3.1 Baseline Published
w

Document Status has the following meaning:
as

Ø   Drafts – These are documents for review and liable to significant change.
w

Ø   Baseline Candidate – The document is ready for final issuing and is only expected to have further minor
n

updates.
io

Ø Baseline – The document is published and is not expected to change significantly. All changes will be listed
at

 
in the change record table.
b lic

Reviewers
pu
is

Name Version Approved Position Date
Th

Adrian Johnston 2.1 EDT 02/07/07
and Tony Miller

Judith Daley 2.1 HMRC 23/06/07

Judith Daley 2.2 HMRC 01/10/07

Adrian Johnston and Tony 3.1 EDT 23/01/08
Miller

Version 3.1 Page 3 of 47 Published Date: 06/03/08

Non-Protectively Marked
UK Government Gateway Document Submission Protocol

Document History

Previous editions of the Government Gateway Customer Documentation Set have included the following documents:

Gateway Document Submission Protocol

This document, GGTE011 Government Gateway Document Submission Protocol replaces the document listed
above.

7.
Note: This pdf document is created directly from the UK Government Gateway ISV Developer help (.chm) file. It is
not available in Word format.

01
r2
be
em
ov
N
2
on
n
aw
dr
ith
w
as
w
n
io
at
b lic
pu
is
Th

Version 3.1 Page 4 of 47 Published Date: 06/03/08

5. DATA_REQUEST 33-35 n 3.5. End-Points 10 3. Appendix A: Error-Return Codes 39-40 dr 5. SUBMISSION_POLL 18-19 r2 3.7. DELETE_REQUEST 29-30 3.5.1 Page 5 of 47 Published Date: 06/03/08 . Non-Protectively Marked UK Government Gateway Document Submission Protocol Table Of Contents 1. Appendix E: Glossary 45-47 w n io at b lic pu is Th Version 3.3.4. SUBMISSION_REQUEST 12-15 7. Business Response 24-25 ov 3. SUBMISSION_RESPONSE/ERROR 23 em 3.6.9. Client Message Definitions 11 3. Appendix B: Digital Signature Authentication 41-42 ith 6. DELETE_RESPONSE 2 31-32 on 3.2. SUBMISSION_ACKNOWLEDGEMENT 16-17 01 3. 3. Business Error Response 26-28 N 3. Document Submission Message Sequence 8-9 2. SUBMISSION_ERROR 20-22 be 3.2. Introduction 6 2.2. Document Submission Protocol 7 2.1.1. Appendix C: Error-Response Schema (Business Erorrs) 43 w 7.1.8. Appendix D: ISV Test Service 44 as 8. DATA_RESPONSE 36-38 aw 4.

Non-Protectively Marked UK Government Gateway Document Submission Protocol 1 Introduction Purpose of the Document This document describes the Document Submission Protocol implementation used by the Government Gateway. any changes that are made between the various revisions of this protocol in order to provide technical information to assist with migrating to future versions of the protocol. client applications.1 Page 6 of 47 Published Date: 06/03/08 . r2 Glossary of Terms be See Appendix (Section 8). and any future versions will continue to show. Intended Readership This document is intended for architects.chm) file available on request from the EDT. Any further refinements and modifications to this protocol will appear in subsequent revisions of this document. ISV developers and other parties interested in building Gateway 7. em ov N 2 on n aw dr ith w as w n io at b lic pu is Th Version 3. This document shows. 01 Note: The information in this document is also included in the ISV developer on-line help (.

govtalk. GovTalk documents are XML formatted and use the UTF-8 encoding standard. to the appropriate Department (back-end) system and retrieves the corresponding response. through the Gateway. Self assessment tax forms) submitted from either a Department Portal (e. The full description 7. of the GovTalk 2.asp?subjects=11.g.0 Envelope schema is available at 01 http://www. Non-Protectively Marked UK Government Gateway Document Submission Protocol 2 Document Submission Protocol Document Submission Protocol The Document Submission Protocol (DSP) routes business transactions (e.uk/schemasstandards/schemalibrary_list. Messages are transported r2 across the network using the Hypertext Transport Protocol (HTTP). the HMRC Online service Web site) or directly from an ISV application. ISV applications and Departments (DIS) must be capable of generating HTTP 1. em ov N 2 on n aw dr ith w as w n io at b lic pu is Th Version 3.1 Page 7 of 47 Published Date: 06/03/08 .1 POST requests and receiving and interpreting HTTP 1.g. GovTalk Protocol DSP uses the GovTalk Message Envelope to encapsulate business transaction documents.1 be response messages.gov. Portals.

The Gateway has now processed the message so replies with a SUBMISSION_RESPONSE 6 message to indicate to the client application that it has finished processing the document. 01 r2 be em ov N 2 on n aw dr ith w as Submission Sequence w Step Action n A SUBMISSION_REQUEST is sent to the Gateway to indicate that a new document is being io 1 submitted for processing. The Gateway has not completed processing the message so again replies with a 4 SUBMISSION_ACKNOWLEDGEMENT to indicate this to the client application. Version 3. Then checks the progress of the submission using the SUBMISSION_POLL message. 7.1 Page 8 of 47 Published Date: 06/03/08 .1 Document Submission Message Sequence Introduction This is the typical sequence followed when a client application submits a document to a Target Spoke (i. The b 2 SUBMISSION_ACKNOWLEDGEMENT includes a CorrelationID to the client application which the pu client can use as an identifier for this document in future poll requests.e. Then checks the progress of the submission using the SUBMISSION_POLL message. is The client application waits for the period specified in the PollInterval attribute of the GovTalk Th 3 header of the SUBMISSION_ACKNOWLEDGEMENT message. Non-Protectively Marked UK Government Gateway Document Submission Protocol 2. at The Gateway replies to the client with a SUBMISSION_ACKNOWLEDGEMENT only once it has lic validated the GovTalk header (include credentials if required). The client application again waits for period specified in the PollInterval attribute of the GovTalk 5 header of the SUBMISSION_ACKNOWLEDGEMENT message. The Gateway sends the submission on to the destination Department (DIS). a Department service) – assuming their are no errors.

Note: A client Portal/application does not necessarily have to process each document sequentially as described above. submitting a number of documents over a period 7. a client can issue a DATA_REQUEST to see the current 9 status of any submissions sent the Gateway. Although not necessary in this scenario. Instead it could operated in a batch mode.1 Page 9 of 47 Published Date: 06/03/08 . The Gateway responds to let the client application know that the message (and all associated 8 resources) have been deleted with a DELETE_RESPONSE. 10 The Gateway responds with a list of submission and their current state with a DATA_RESPONSE. Non-Protectively Marked UK Government Gateway Document Submission Protocol Having received a SUBMISSION_RESPONSE the client application must delete the copy of the 7 response stored on the gateway by submitting a DELETE_REQUEST message to the Gateway. of time and then later using: 01 l DATA_REQUEST to examine the state of these submissions l SUBMISSION_POLL to retrieve the corresponding response for each submission r2 l DELETE_REQUEST to delete each submission from the Gateway be l SUBMISSION_REQUEST to resubmit documents with recoverable errors em ov N 2 on n aw dr ith w as w n io at b lic pu is Th Version 3.

2 End-Points Gateway End-Points used by the Document Submission Protocol 7.gov.uk/submission io at l GovTalk Header ¡ Sender authentication information required (SenderDetails and GovTalkDetails/Key lic elements) depends on the authentication level setting of the target service b ¡ Should not include ResponseEndPoint element pu l GovTalk EnvelopeVersion is 1.0 is Th Version 3.0 or 2. 01 r2 be em ov N 2 on n aw dr ith w as DSP Submission end-point (for DSP messages issued by Portals/ISV applications to Gateway) w l Accessible over the Internet (server-side SSL connection) n ¡ https://secure.1 Page 10 of 47 Published Date: 06/03/08 . Non-Protectively Marked UK Government Gateway Document Submission Protocol 2.gateway.

asp?subjects=11). Together these two elements denote the message type.5) – business response/error from Target Spoke (i. n aw dr ith w as w n io at b lic pu is Th Version 3.1 Page 11 of 47 Published Date: 06/03/08 .2) em l SUBMISSION_ERROR (Section 3. Non-Protectively Marked UK Government Gateway Document Submission Protocol 3 Client Message Definitions Messages exchanged between the Client (e. ISV applications or Portal) and the Gateway The protocol makes extensive use of the envelope portion of the GovTalk schema (http://www.uk/schemasstandards/schemalibrary_list.4) – error detected in message received from the Client l SUBMISSION_RESPONSE/ERROR (Section 3.govtalk.gov.e. l SUBMISSION_POLL (Section 3.1) 7.6) DATA_REQUEST (Section 3. ov Department) l DELETE_RESPONSE (Section 3. the Portal's or on ISV application) to ensure each message conforms to the relevant syntactical rules for that particular type of message.8) r2 l Messages issued by the Gateway: be l SUBMISSION_ACKNOWLEDGEMENT (Section 3.g. Messages issued by the client application: l SUBMISSION_REQUEST (Section 3.9) 2 When submitting any message type to the Gateway it is the responsibility of the issuer (i.3) 01 l DELETE_REQUEST (Section 3.7) N l DATA_RESPONSE (Section 3.e. Each document submitted to the Gateway must include a Qualifier element immediately after the Class element.

The dr enrolment (identified by Keys) can be access either by a client enrolled in the service or an agent authorised to use the enrolment. GovTalkMessage Body. MANDATORY.e. in addition to identifying the document type in the GovTalkMessage Body. Set to 2. a subset of the client allocations) the pu organisation/agent has for which the DRM User can make submissions is Message Structure Th GovTalkMessage MANDATORY. Header MANDATORY. be Whether the SenderDetails is required in the message depends on the target service's Authentication Level (configured in the Gateway) which is the minimum authentication credential an entity must have to use the em service.gov. Version 3. Department) back-end system in the 7. This value is used by the Gateway to determine the checking/authentication to be performed: l Level 0: ov ¡ Type 0: SenderDetails not checked N ¡ Type 1: SenderDetails checked for either: 2 n A User ID registered with the Gateway (password is not checked) n A valid certificate (though not necessarily known to Gateway) with a valid message on digest ¡ Type 2: SenderDetails checked for a valid certificate (though not necessarily known to n Gateway) with a valid message digest aw l Level 1: SenderDetails (either User ID/password or certificate) authenticated by Gateway. username/password or digital signature) lic l DRM user's email address b l Subset of direct enrolments (and additionally for agents.1 SUBMISSION_REQUEST Message Source/Destination Portal/Client application to Gateway Processing The SUBMISSION_REQUEST message is the initial message sent between the client application and the Gateway. ith l Level 2: SenderDetails (must be certificate) authenticated by Gateway. This payload in the body is opaque to the Gateway and is associated with an appropriate XML namespace.0 for backward compatibility.0. is used by Gateway to identify the Target Spoke (i.1 Page 12 of 47 Published Date: 06/03/08 .e. r2 The Class. Identifies the class of XML document contained Class within the Body. as Note: w Submissions from an organisation/agent can be made by a Delegated Rights Management (DRM) User (as well as by a normal Gateway User or Assistant). The document contained within the Body element must include a single root 01 XML node which wraps the data.gateway. Non-Protectively Marked UK Government Gateway Document Submission Protocol 3. MessageDetails MANDATORY. This message contains the document for the Target Spoke (i. or to 1. A default namespace specified as “http://www.uk) by an existing Gateway User within the organisation/agent – io to represent the organisation. Through the UI the User specifies: at l DRM user's authentication credential (i. EnvelopeVersion MANDATORY. A DRM user is setup up for an organisation/agent – n through the Gateway UI (www.gov.govtalk.e. The enrolment (identified by w Keys) can be access either by a client enrolled in the service or an agent authorised to use the enrolment.uk/CM/envelope”. Department) and the service the document is to be routed to.

Set to MD5 or clear.e Department). If present must conform to the XSD pattern defined in the GovTalk envelope specification ([0-9A-F]{0. This element will be empty or can be omitted. It is recommended this value maintains uniqueness to assist the client (i. If present must conform to the XSD pattern defined in the GovTalk envelope specification ([0-9A-F]{0. 01 OPTIONAL. pu For username / password authentication the following elements must be set within the is SenderDetails/IDAuthentication block: Th SenderID MANDATORY. where element is present. n aw GatewayTimestamp OPTIONAL. Set to XML. 7. N Transformation MANDATORY. Element must be empty. This value will be reflected in the SUBMISSION_ERROR or SUBMISSION_RESPONSE message back to the Portal/client TransactionID application. it must on GatewayTest (Section 7) be set to 0. This allows a client to specify a SMTP notification n address for the current submission. Value If the value of the Method element is MD5 then Value is calculated from the clear password by: 1. Function MANDATORY.1 Page 13 of 47 Published Date: 06/03/08 . OPTIONAL. Set to submit.e. This is ith the credentials of the client initiating the business message. OPTIONAL. Portal or client application) with interpreting a response from Gateway. Converting to lower case and UTF-8 encoding Version 3. Element must be empty. then the initiator of this message will be notified b when a response has been received from the back-end system. For ISV Test Service. w OPTIONAL. where element is present it must be set to 1. MANDATORY. Either a username/password or digital signature dr authentication block (as described below) will be included. For live submissions. Non-Protectively Marked UK Government Gateway Document Submission Protocol Qualifier MANDATORY. io If element is omitted (or included. It is recommended that this element is not present. AuditID r2 The Gateway forwards this value on to the Target Spoke (i.32}). but left empty) then the user's at EmailAddress email address registered with the Gateway will be used. The use of clear is not Method recommended. 2 OPTIONAL. em OPTIONAL. Set to request. be CorrelationID MANDATORY. Set to supplied client account name MANDATORY.32}). SenderDetails Note: If the SUBMISSION_REQUEST is made for a Level 0 (Type w 0) then authentication credentials are not required – see as description of Level/Type in Processing section (above). lic Provided the Send Mail flag (on the Gateway) for this class of transaction is set. If the value of the Method element is clear then Value must contain a clear text password. If ResponseEndPoint ov present it should be empty.

1 or 2) then no Key elements are required. ov TargetDetails OPTIONAL. 2 OPTIONAL. Non-Protectively Marked UK Government Gateway Document Submission Protocol 2. Set to W3Csigned. n aw OPTIONAL. <?xml version="1. as GovTalkErrors OPTIONAL. This element and any valid subordinates may be present.0"?> <GovTalkMessage xmlns="http://www. Should contain a valid document for the specified transaction type.gov. Element should be empty. io at OPTIONAL. It is recommended that this element is not present. w Note: The subordinate fields of this element are not currently used by the submission protocol. Signature (Section 5) See the W3C signing documentation on the W3C site (http://www. It is recommended that this element is not present. Note: If the authentication level of the target service is Level 0 em (Type 0. Must contain the appropriate Key element/attribute entries that identify the enrolment the entity has for the document be Key type being submitted. w n GatewayAdditions OPTIONAL.0</EnvelopeVersion> <Header> <MessageDetails> <Class>MOSWTSC2 </Class> <Qualifier>request</Qualifier> Version 3. MD5 hashing 3. GovTalkDetails MANDATORY. on GatewayValidation Note: The subordinate fields of this element are not currently used by the submission protocol.uk/CM/envelope"> <EnvelopeVersion>2.uk/CM/envelope and must be pu particular to the submitted document type.govtalk. If present must be populated with a string between 1 N Organisation and 64 characters in length. Application vendors may use this element and its dr subordinates to communicate details of their application name and version together with any specific transaction ID values for this ith ChannelRouting submission. Keys MANDATORY 01 r2 OPTIONAL. OPTIONAL. Base64 encoding For digital signature authentication the following elements must be set: Method MANDATORY. The document contained within this element lic Body must have a single root node associated with a default namespace b other than http://www.gov.govtalk. Must be populated with the XML node structure necessary to provide a valid digital signature block.1 Page 14 of 47 Published Date: 06/03/08 . MANDATORY. is Th Samples The mandatory elements within the following sample submission request are shown in bold while optional elements appear in normal type. 7.org/TR/xmldsig-core). It is recommended that this should not be present.w3.

Non-Protectively Marked UK Government Gateway Document Submission Protocol <Function>submit</Function> <TransactionID>20021202ABC</TransactionID> <CorrelationID></CorrelationID> <Transformation>XML</Transformation> <GatewayTest>0</GatewayTest> <GatewayTimestamp></GatewayTimestamp> </MessageDetails> <SenderDetails> <IDAuthentication> <SenderID>Test000001</SenderID> <Authentication> <Method>MD5</Method> <Value>fSgjkCA3I9k/J24Y5M3qhu==</Value> </Authentication> </IDAuthentication> <EmailAddress>someone@somewhere.1 Page 15 of 47 Published Date: 06/03/08 . </Header> <GovTalkDetails> 01 <Keys> <Key Type="RefNo">0000442355</Key> r2 <Key Type="DOB">29/07/1955</Key> <Key Type="TCH">24-22</Key> </Keys> be </GovTalkDetails> <Body> em <!-.com</EmailAddress> </SenderDetails> 7.A valid Body payload with a namespace declaration on the first element --> </Body> </GovTalkMessage> ov N 2 on n aw dr ith w as w n io at b lic pu is Th Version 3.

Keys MANDATORY. aw Function MANDATORY.32}).e. Set to 2. 01 Message Structure r2 GovTalkMessage MANDATORY. dr ith OPTIONAL. Body MANDATORY. at MANDATORY. Contains a valid HTTP end point address. Element will be empty. Contains the time the message was generated.0 or 1.govtalk. n Qualifier MANDATORY. Non-Protectively Marked UK Government Gateway Document Submission Protocol 3. Set to submit.gov. SenderDetails MANDATORY. em MANDATORY. GatewayTimestamp MANDATORY. n io This will be used with the next SUBMISSION_POLL message. is Note: The PollInterval is based on the average response time for Th document submissions of this class. b The Portal/client application should issue follow-on pu SUBMISSION_POLL messages to this end-point after the ResponseEndPoint recommended delay (in seconds) specified by the value in the PollInterval attribute. The CorrelationID returned is used in the SUBMISSION_POLL message to identify the submission the client is interested in. Identifies the class of XML document contained Class within the Body of the originating submission. Element will be empty GovTalkDetails MANDATORY. SUBMISSION_REQUEST or the associated SUBMISSION_POLL). ov Header MANDATORY. Key elements will not be present. The lic PollInterval attribute will be set to an integer value.1 Page 16 of 47 Published Date: 06/03/08 . Version 3. 7. as MANDATORY. This element will contain a hexadecimal number w encoded as an upper case text string of 32 characters in length CorrelationID ([0-9A-F]{0. A default namespace specified as be “http://www.uk/CM/envelope”. N MessageDetails MANDATORY.2 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. TransactionID If a TransactionID value was provided in either a w SUBMISSION_REQUEST or SUBMISSION_POLL it will be returned.0 to mirror the EnvelopVersion EnvelopeVersion value in request (i. Set to acknowledgement. 2 on MANDATORY.

gov.uk/CM/envelope"> <EnvelopeVersion>1.0</EnvelopeVersion> <Header> <MessageDetails> <Class>MOSWTSC2</Class> <Qualifier>acknowledgement</Qualifier> <Function>submit</Function> 7.1 Page 17 of 47 Published Date: 06/03/08 .govtalk.uk/poll r2 </ResponseEndPoint> <GatewayTimestamp>2001-01-31T10:20:18.345</GatewayTimestamp> </MessageDetails> be <SenderDetails/> </Header> em <GovTalkDetails> <Keys/> </GovTalkDetails> ov <Body/> </GovTalkMessage> N 2 on n aw dr ith w as w n io at b lic pu is Th Version 3.gov. Non-Protectively Marked UK Government Gateway Document Submission Protocol Samples The mandatory elements within the following sample submission acknowledgement are shown in bold while optional elements appear in normal type.gateway. <TransactionID>20021202ABC</TransactionID> <CorrelationID>B07B9ED3176193DDC4EC39063848A927</CorrelationID> 01 <ResponseEndPoint PollInterval=”10”> https://secure. <?xml version="1.0"?> <GovTalkMessage xmlns="http://www.

If present must conform to the XSD pattern defined in b the GovTalk envelope specification ([0-9A-F]{0. or to 1. Must be set to the value returned by the Th CorrelationID SUBMISSION_ACKNOWLEDGEMENT. If no match is found an error is raised. Element should be empty. Set to 2. Set to submit. If present must conform to the XSD pattern defined in n the GovTalk envelope specification ([0-9A-F]{0.1 Page 18 of 47 Published Date: 06/03/08 . Transformation MANDATORY. Version 3. GatewayTimestamp OPTIONAL.32}). GovTalkDetails MANDATORY. 7. Key elements should not be present. on EnvelopeVersion MANDATORY. w Qualifier MANDATORY. Its inclusion ensures that users with a digital signature 01 submission do not have to constantly re-enter their PIN number. is MANDATORY. Identifies the class of XML document contained Class ith within the Body of the originating submission. lic OPTIONAL. It is recommended that SenderDetails this element is not present. Element should be empty. Set to XML.govtalk. Set to poll. When performing a SUBMISSION_POLL Gateway checks if the given Class be matches that stored in the Gateway corresponding to the associated CorrelationID. OPTIONAL. Header MANDATORY. It is recommended is not present. 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. AuditID pu This element are not currently used by the submission protocol.0 for backward compatibility. r2 The Class must match the Class value that was originally provided in the SUBMISSION_REQUEST which returned the CorrelationID.gov.3 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. A default namespace specified as 2 “http://www.0. The CorrelationID uniquely identifies the client. Any security details that are provided will be ignored. em ov Message Structure N GovTalkMessage MANDATORY. Keys MANDATORY. dr MANDATORY. TransactionID io This value is returned by the at corresponding SUBMISSION_ACKNOWLEDGEMENT message. n aw MessageDetails MANDATORY. as Function MANDATORY. w OPTIONAL. Non-Protectively Marked UK Government Gateway Document Submission Protocol 3.32}).uk/CM/envelope”.

Samples The mandatory elements within the following sample submission poll are shown in bold while optional elements appear in normal type.1 Page 19 of 47 Published Date: 06/03/08 .govtalk.uk/CM/envelope"> <EnvelopeVersion>2.gov. 7.0"?> <GovTalkMessage xmlns="http://www. 01 <?xml version="1.0</EnvelopeVersion> r2 <Header> <MessageDetails> be <Class>MOSWTSC2</Class> <Qualifier>poll</Qualifier> em <Function>submit</Function> <CorrelationID>B07B9ED3176193DDC4EC39063848A927</CorrelationID> <Transformation>XML</Transformation> </MessageDetails> ov <SenderDetails/> </Header> N <GovTalkDetails> <Keys/> </GovTalkDetails> <Body/> 2 on </GovTalkMessage> n aw dr ith w as w n io at b lic pu is Th Version 3. Element should be empty. Non-Protectively Marked UK Government Gateway Document Submission Protocol Body OPTIONAL.

This message can be returned by the Gateway for a number of reasons: em l An invalid document is submitted that fails DSP schema/protocol validation ov l The Gateway Service has been disabled for scheduled downtime of a back-end system – an Internal error. the initial SUBMISSION_REQUEST may be missing the Class element. 2 on n aw dr ith w as w n For example. lic The behaviour of the client system depends on the point at which the error occurred. or a io SUBMISSION_POLL may be missing a CorrelationID.govtalk.0 or 1. Header MANDATORY. Th Message Structure GovTalkMessage MANDATORY. the Gateway will return a at SUBMISSION_ERROR message with an Error/Type of fatal. Non-Protectively Marked UK Government Gateway Document Submission Protocol 3. the client application must continue the sequence using the value of CorrelationID from the original SUBMISSION_RESPONSE. This may include syntax checks on the entire be GovTalkMessage. l DELETE_REQUEST 01 l DATA_REQUEST r2 The GovTalkErrors element will describe the error(s). A default namespace specified as “http://www.4 SUBMISSION_ERROR Message Source/Destination Gateway to Portal/Client application Processing The SUBMISSION_ERROR message can be returned for all client initiated messages. Version 3. as illustrated.uk/CM/envelope”. MessageDetails MANDATORY.0 to the mirror EnvelopVersion value EnvelopeVersion in the client message that failed. If the error occurred on b a SUBMISSION_REQUEST. the client should correct the error and resubmit the message. is Note: the DATA_REQUEST verb can be used to identify those submission sequences that have not completed successfully. Either of these errors is classed as fatal since the Gateway does not have sufficient information to process the message. l SUBMISSION_REQUEST l SUBMISSION_POLL 7.1 Page 20 of 47 Published Date: 06/03/08 . MANDATORY. If it occurs later in pu the sequence. In this case. Set to 2. N l The back-end system does not respond in a timely manner. The SUBMISSION_ERROR will only be generated when the client message cannot be processed by the Gateway.gov.

Key elements will not be present. w Error/Type MANDATORY. n GovTalkDetails MANDATORY. Contains location related information – can be Error/Location empty. Contains additional information which should be of io Error/Text assistance in correcting the problem. Contains a published error code value. ov ResponseEndPoint The Portal/client application can issue follow-on messages to this end-point after the recommended delay (in seconds) which is N indicated by the value in the PollInterval attribute. If the client SUBMISSION_REQUEST supplied a TransactionID TransactionID it will be returned in this element. Qualifier MANDATORY. dr GovTalkErrors MANDATORY. Function MANDATORY. Set to error. Identifies the class of document for which the error Class is raised. Can include multiple Error elements. GatewayTimestamp 2 MANDATORY.gov.govtalk. Element will be empty. Contains a valid HTTP end point address. n MANDATORY. Set to fatal.0"?> <GovTalkMessage xmlns="http://www. <?xml version="1. If the error was encountered before this is determined the generic UndefinedClass value will be returned. MANDATORY. on SenderDetails MANDATORY. Contains the time the message was generated. l For SUBMISSION_POLL – This would normally be the value 01 CorrelationID provided in the previous SUBMISSION_ACKNOWLEDGE l For DELETE_REQUEST . b pu Body MANDATORY. ith w Error/RaisedBy MANDATORY. The PollInterval attribute will be set to an integer value. Set to submit.uk/CM/envelope"> <EnvelopeVersion>1. MANDATORY. Depends on the message that caused the error: l For SUBMISSION_REQUEST – Provided by Gateway 7.0</EnvelopeVersion> <Header> <MessageDetails> <Class>MOSWTSC2</Class> Version 3. Element will be empty.This would normally be the value r2 provided in the associated SUBMISSION_RESPONSE be l For DATA_REQUEST . Set to Gateway. aw Keys MANDATORY.1 Page 21 of 47 Published Date: 06/03/08 .Provided by Gateway em MANDATORY. at lic MANDATORY. as Error/Number MANDATORY. Non-Protectively Marked UK Government Gateway Document Submission Protocol MANDATORY. is Th Samples The mandatory elements within the following sample submission error are shown in bold while optional elements appear in normal type.

345</GatewayTimestamp> </MessageDetails> <SenderDetails/> </Header> <GovTalkDetails> <Keys/> <GovTalkErrors> <Error> <RaisedBy>Gateway</RaisedBy> <Number>1020</Number> 7.1 Page 22 of 47 Published Date: 06/03/08 .gateway.uk/submission </ResponseEndPoint> <GatewayTimestamp>2001-01-31T10:20:18.gov. Non-Protectively Marked UK Government Gateway Document Submission Protocol <Qualifier>error</Qualifier> <Function>submit</Function> <TransactionID>20021202ABC</TransactionID> <CorrelationID>1DF257B5CD23F4A5B6C7D8E9F102932</CorrelationID> <ResponseEndPoint PollInterval=”2”> https://secure. <Type>fatal</Type> <Text>A meaningful description of the error</Text> 01 <Location></Location> </Error> r2 </GovTalkErrors> </GovTalkDetails> <Body/> be </GovTalkMessage> em ov N 2 on n aw dr ith w as w n io at b lic pu is Th Version 3.

5 SUBMISSION_RESPONSE/ERROR Submission Response Once the Department has processed the client SUBMISSION_REQUEST it will respond to the Gateway with either a: l Business Response (Section 3.5.1) l Error Response (Section 3. The document 7.2) This response is forwarded on to the client. contained within the Body element must therefore include a single root XML node which wraps the returned 01 data.1 Page 23 of 47 Published Date: 06/03/08 . Non-Protectively Marked UK Government Gateway Document Submission Protocol 3. This payload is opaque to the Gateway and will be associated with an appropriate XML namespace. r2 be em ov N 2 on n aw dr ith w as w n io at b lic pu is Th Version 3.5. This message may include a GovTalkMessage Body payload returned from the back-end system.

Non-Protectively Marked UK Government Gateway Document Submission Protocol 3. n io Function MANDATORY. Identifies the class of XML document contained Class within the Body of the originating submission – supplied in as the SUBMISSION_REQUEST. SenderDetails MANDATORY. w MANDATORY.1 Page 24 of 47 Published Date: 06/03/08 . the Gateway will respond to the next SUBMISSION_POLL message. This would be necessary. The document 01 contained within the Body element must therefore include a single root XML node which wraps the returned data. This message may include a GovTalkMessage Body payload returned from the back-end system. The PollInterval attribute will be set to an integer value.gov. Element will be empty. Populated with CorrelationID associated with original CorrelationID submission (i. Version 3.e returned in the SUBMISSION_ACKNOWLEDGE). dr ith MessageDetails MANDATORY.5. em Note: The elements in the message are mostly populated from the Business Response received from the Department.g. GovTalkDetails MANDATORY.0 to the mirror EnvelopVersion value EnvelopeVersion aw in the associated SUBMISSION_POLL.0 or 1. Set to response. w Qualifier MANDATORY. at MANDATORY. containing the matching CorrelationID.uk/CM/envelope”. Otherwise element will be empty. r2 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. Transformation MANDATORY. n MANDATORY. A default namespace specified as “http://www. be for example. Contains the time the message was generated.1 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. b pu MANDATORY. is This value is used in the DELETE_REQUEST message. Set to submit. If the SUBMISSION_REQUEST supplied a lic TransactionID TransactionID it will be returned in this element. Header MANDATORY.govtalk. ResponseEndPoint The Portal/client application should issue follow-on messages (e. Set to XML. Contains a valid HTTP end point address. 7. GatewayTimestamp MANDATORY. Th MANDATORY. Set to 2. ov N Message Structure 2 on GovTalkMessage MANDATORY. This payload is opaque to the Gateway and will be associated with an appropriate XML namespace. if the client encountered a transmission error during the previous SUBMISSION_POLL and received an HTTP error. DELETE_REQUEST or DATA_REQUEST) to this end-point. with the appropriate SUBMISSION_RESPONSE message.

e.345</GatewayTimestamp> </MessageDetails> is <SenderDetails/> Th </Header> <GovTalkDetails> <Keys/> </GovTalkDetails> <Body> <DepartmentDocument xmlns="http://www. If a document is included it must have a single root node associated 2 with another namespace specific to the submitted document type. ChannelRouting be Target Spokes (i.e Organisation Department).0</EnvelopeVersion> <Header> <MessageDetails> n <Class>MOSWTSC2</Class> io <Qualifier>response</Qualifier> <Function>submit</Function> at <TransactionID>20021202ABC</TransactionID> lic <CorrelationID>B07B9ED3176193DDC4EC39063848A927</CorrelationID> <ResponseEndPoint PollInterval=”2”> b https://secure. ov MANDATORY. 01 OPTIONAL. Departments) may use this element and its sub-ordinates to communicate details of their application name em and version together with any specific transaction ID values for this submission. Populated with the GatewayValidation element/sub- GatewayValidation elements in the business response message returned from the Target Spoke (i.govtalk.uk/namespace"> <Data> ABC </Data> </DepartmentDocument> </Body> </GovTalkMessage> Version 3.1 Page 25 of 47 Published Date: 06/03/08 .e Department). Non-Protectively Marked UK Government Gateway Document Submission Protocol Keys MANDATORY. w as <?xml version="1. The Body element may be empty or contain a valid N Body business document returned from the back-end system. Populated with the Organisation element in the business response message returned from the Target Spoke (i. OPTIONAL. Key elements will not be present. OPTIONAL.organisation. If present it will contain a string between 1 and 64 characters in length. 7.uk/submission </ResponseEndPoint> pu <Transformation>XML</Transformation> <GatewayTimestamp>2001-01-31T10:20:18. on n aw Samples dr The mandatory elements within the following sample submission business response are shown in bold ith while optional elements appear in normal type. TargetDetails OPTIONAL.e Department).gateway.gov.gov.uk/CM/envelope"> w <EnvelopeVersion>1.0"?> <GovTalkMessage xmlns="http://www.gov. Populated with the ChannelRouting element/sub- elements in the business response message returned from the r2 Target Spoke (i.

Identifies the class of XML document contained within the Class Body of the originating submission – supplied in Version 3.1 Page 26 of 47 Published Date: 06/03/08 . A default namespace specified as “http://www. The client must continue with the protocol sequence until a DELETE_RESPONSE has been received. Non-Protectively Marked UK Government Gateway Document Submission Protocol 3. Set to 2. MessageDetails MANDATORY. the Gateway returns a Business Response Error message (with an Error/Type of business or lic fatal) to the client. 01 r2 be em ov N 2 on n aw dr ith w as w n io at As illustrated.0 to the mirror EnvelopVersion value in EnvelopeVersion the associated SUBMISSION_POLL.0 or 1. b pu Note: The elements in the message are mostly populated from the Business Error Response received from the Department.govtalk. MANDATORY. 7. when forwarded to the Department.uk/CM/envelope”. Header MANDATORY. MANDATORY.gov.5. The client should correct the error and re-submit as a new transaction. is Th Message Structure GovTalkMessage MANDATORY.2 Business Error Response Message Source/Destination Gateway to Portal/Client application Processing A Business Response Error occurs when a document submitted to the Gateway passes all schema/protocol validation performed by Gateway and then. is rejected because it does not conform to the business logic required by the back-end system – typically as a result of inconsistent data values provided in the XML elements in the Body.

Qualifier MANDATORY.1 Page 27 of 47 Published Date: 06/03/08 . Populated with the ChannelRouting element/sub- n elements in the business response message returned from the Target io Spoke (i. Key elements will not be present. Populated with CorrelationID associated with original CorrelationID submission (i. 7. Error/Type MANDATORY. w OPTIONAL. Th MANDATORY.e returned in the SUBMISSION_ACKNOWLEDGE) This value is used in the DELETE_REQUEST message. The PollInterval 01 attribute will be set to an integer value. Contains a valid HTTP end point address. Set to error. MANDATORY.e. Contains additional information which should be of Error/Text assistance in correcting the problem. This should be set to the value associated with the Error/Number Error/Type (i. at ChannelRouting Target Spokes (i. Error/Location OPTIONAL. 2 on Keys MANDATORY. Contains location related information. n aw TargetDetails OPTIONAL.e Department). Set to submit. OPTIONAL. Otherwise element will be empty. is Error/RaisedBy MANDATORY Set to department. 3000 or 3001). Set to XML. Version 3. b pu GovTalkErrors MANDATORY. Set to fatal (for 3000) or business (for 3001). Contains the time the message was generated.e Department). DELETE_REQUEST or DATA_REQUEST) to this end-point. Departments) may use this element and its sub- lic ordinates to communicate details of their application name and version together with any specific transaction ID values for this submission. GatewayTimestamp MANDATORY.e Department).g. If Organisation present it will be contain a string between 1 and 64 characters in ith length. If the SUBMISSION_REQUEST supplied a TransactionID it TransactionID will be returned in this element. Function MANDATORY. MANDATORY. MANDATORY.e. Populated with the Organisation element in the business dr response message returned from the Target Spoke (i. ResponseEndPoint r2 The Portal/client application can issue follow-on messages (e. OPTIONAL. Populated with the GatewayValidation element/sub- as GatewayValidation elements in the business response message returned from the Target Spoke (i. ov N SenderDetails MANDATORY. Non-Protectively Marked UK Government Gateway Document Submission Protocol the SUBMISSION_REQUEST. GovTalkDetails MANDATORY. w OPTIONAL. Element will be empty. be em Transformation MANDATORY. Can include multiple Error elements.

uk/CM/errorresponse”> w <Application> <Error> n <RaisedBy>Some Department</RaisedBy> io <Number>34567</Number> <Type>business</Type> at <Text>Calculation mismatch</Text> <Location>MAFF</Location> lic </Error> ….govtalk.0"?> <GovTalkMessage xmlns="http://www. There may be many errors.uk/submission </ResponseEndPoint> N <Transformation>XML</Transformation> <GatewayTimestamp>2001-01-31T10:20:18. This structure of this data conforms to the Error-Response schema (Section 6). Samples The mandatory elements within the following sample business error response request are shown in bold while optional elements appear in normal type. b </Application> pu </ErrorResponse> </Body> </GovTalkMessage> is Th Version 3. 01 <?xml version="1.gateway.gov.0</EnvelopeVersion> r2 <Header> <MessageDetails> be <Class>MOSWTSC2</Class> <Qualifier>error</Qualifier> <Function>submit</Function> em <TransactionID>20021202ABC</TransactionID> <CorrelationID> B07B9ED3176193DDC4EC39063848A927</CorrelationID> <ResponseEndPoint PollInterval=”2”> ov https://secure. For business Error/Type the Body can contain detailed Body department specific error information.gov.1 Page 28 of 47 Published Date: 06/03/08 .345</GatewayTimestamp> </MessageDetails> <SenderDetails/> 2 on </Header> <GovTalkDetails> <Keys/> n <GovTalkErrors> aw <Error> <RaisedBy>department</RaisedBy> <Number>3001</Number> dr <Type>business</Type> ith <Text>Submission of document failed due to departmental business logic</Text> <Location>business</Location> </Error> w </GovTalkErrors> </GovTalkDetails> as <Body> <ErrorResponse xmlns=”http://www. 7. Non-Protectively Marked UK Government Gateway Document Submission Protocol MANDATORY.gov. This data is transparent to the Gateway. not just a single error.govtalk.uk/CM/envelope"> <EnvelopeVersion>1..

A default namespace specified as “http://www. If the error indicates the N CorrelationID cannot be found (typically error code 2000) then the client can cease sending the DELETE_REQUEST message. Set to XML.uk/CM/envelope”. If the DELETE_REQUEST message is not sent the Gateway will automatically delete the resources 7. related to the CorrelationID within 60 days. b pu Qualifier MANDATORY. Th OPTIONAL.govtalk. The CorrelationID specifies the message to be deleted from the Gateway. Set to request. Must conform to the XSD pattern defined in the GovTalk envelope specification ([0-9A-F]{0. If the client issues this request the implication is that aw the client no longer wishes to progress the submission via the Gateway and will reconcile the transaction through some other means.32}). Set to delete. dr ith Message Structure w GovTalkMessage MANDATORY.gov. MANDATORY. or to 1. If the client receives a SUBMISSION_ERROR message it must process any standard errors in the normal way and then reissue the DELETE_REQUEST message. n io MessageDetails MANDATORY.0. When performing a DELETE_REQUEST the Gateway checks if the given Class matches that em stored in the Gateway for that particular correlationID – if no match is found an error will be returned. Non-Protectively Marked UK Government Gateway Document Submission Protocol 3. This value will be returned in the subsequent DELETE_RESPONSE. Header MANDATORY. Set to 2. Transformation MANDATORY. If the DELETE_REQUEST message is not sent the Gateway will automatically delete the r2 resources related to the CorrelationID within 30 days. Identifies the class of XML document to be deleted Class from Gateway. the Gateway can return either a DELETE_RESPONSE or a ov SUBMISSION_ERROR message. Must be set to the value returned by the associated CorrelationID SUBMISSION_RESPONSE. In response to the DELETE_REQUEST message. Version 3. is Function MANDATORY. 01 l To signify it has processed a Business Error response message it obtained (by polling) from the Gateway.1 Page 29 of 47 Published Date: 06/03/08 . at lic MANDATORY. 2 Note: If the client issues a DELETE_REQUEST message before a Business/Business Error response or on SUBMISSION_RESPONSE has been returned from the Gateway the resources associated with the transaction on the Gateway will be removed.6 DELETE_REQUEST Message Source/Destination Portal/Client application to Gateway Processing This message should be sent by the client to the Gateway: l To signify it has processed a Business response message it obtained (by polling) from the Gateway. as w EnvelopeVersion MANDATORY.0 for backward compatibility. The Class must match the Class be value that was obtained in the Business/Business Error response (or SUBMISSION_ERROR that returned the CorrelationID). TransactionID It is recommended that it should be set to the value present in the SUBMISSION_RESPONSE. This will not prevent the original submission from being sent to the back- n end system – there are no associated recall semantics.

where element is present it must be set to 1.govtalk.0</EnvelopeVersion> <Header> N <MessageDetails> <Class>MOSWTSC2</Class> <Qualifier>request</Qualifier> <Function>delete</Function> 2 on <CorrelationID>B07B9ED3176193DDC4EC39063848A927</CorrelationID> <Transformation>XML</Transformation> <GatewayTimestamp/> n </MessageDetails> aw <SenderDetails/> </Header> dr <GovTalkDetails> <Keys/> ith </GovTalkDetails> <Body> </Body> w </GovTalkMessage> as w n io at b lic pu is Th Version 3.1 Page 30 of 47 Published Date: 06/03/08 . Non-Protectively Marked UK Government Gateway Document Submission Protocol OPTIONAL. em <?xml version="1. Element should be empty.gov.uk/CM/envelope"> <EnvelopeVersion>2. SenderDetails OPTIONAL. For live submissions. Keys MANDATORY.0"?> ov <GovTalkMessage xmlns="http://www. where element is present. it must GatewayTest (Section 7) be set to 0. GatewayTimestamp OPTIONAL. 7. 01 Samples r2 The mandatory elements within the following sample delete request are shown in bold while optional be elements appear in normal type. Element should be empty. For ISV Test Service. GovTalkDetails MANDATORY. Element should be empty. Body OPTIONAL. If Key elements are present they will be ignored.

If the DELETE_REQUEST supplied a TransactionID it TransactionID will be returned in this element. A default namespace specified as r2 “http://www. Set to delete. 2 on Qualifier MANDATORY. Element will be empty.gov. 7. Populated with the value from the CorrelationID DELETE_REQUEST. Set to response. <?xml version="1. Key elements will not be present. ResponseEndPoint w Note: This element and its value has no significance here and should be ignored. Function MANDATORY. The as PollInterval attribute is set to a non-negative integer. w MANDATORY. n aw MANDATORY. pu Keys MANDATORY. Message Structure 01 GovTalkMessage MANDATORY. Th Samples The mandatory elements within the following sample delete response are shown in bold while optional elements appear in normal type. be MANDATORY.7 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. Identifies the class of XML document deleted from Class Gateway – supplied in the DELETE_REQUEST. em Header MANDATORY.govtalk.govtalk. at lic SenderDetails MANDATORY. Contains the time the message was generated.0 or 1. N MANDATORY. Non-Protectively Marked UK Government Gateway Document Submission Protocol 3.uk/CM/envelope”.0"?> <GovTalkMessage xmlns="http://www.uk/envelope"> <EnvelopeVersion>1.gov. ov MessageDetails MANDATORY.0 to mirror the EnvelopVersion value EnvelopeVersion in the associated DELETE_REQUEST.0</EnvelopeVersion> <Header> Version 3. n io GatewayTimestamp MANDATORY. b GovTalkDetails MANDATORY. Set to 2. is Body MANDATORY. Element will be empty. Contains a valid HTTP end-point address.1 Page 31 of 47 Published Date: 06/03/08 . dr ith MANDATORY.

gov.795</GatewayTimestamp> </MessageDetails> <SenderDetails/> </Header> <GovTalkDetails> <Keys/> </GovTalkDetails> <Body> 7.uk/submission </ResponseEndPoint> <GatewayTimestamp>2001-02-25T16:32:18.gateway. Non-Protectively Marked UK Government Gateway Document Submission Protocol <MessageDetails> <Class>MOSWTSC2</Class> <Qualifier>response</Qualifier> <Function>delete</Function> <TransactionID/> <CorrelationID>B07B9ED3176193DDC4EC39063848A927</CorrelationID> <ResponseEndPoint PollInterval=”10”> https://secure.1 Page 32 of 47 Published Date: 06/03/08 . </Body> </GovTalkMessage> 01 r2 be em ov N 2 on n aw dr ith w as w n io at b lic pu is Th Version 3.

Element must be empty. CorrelationID MANDATORY. The client can therefore determine if the submitted document is being handled by the Gateway by virtue of the fact that the document appears in the DATA_RESPONSE. A default namespace specified as ith “http://www.0 for backward compatibility.0. it must GatewayTest (Section 7) be set to 0. The Class of the document filters the returned list of CorrelationIDs 7. The client should act promptly on documents if concerned about their status . Class This class filters the returned list of CorrelationIDs currently being at handled by Gateway. where element is present it must be set to 1. and therefore requires the same credentials to be be presented by the Portal/client application as were used when submitting the original document. n io MANDATORY.uk/CM/envelope”. if any. The DATA_REQUEST message must be authenticated.for example Gateway will remove: N l Successful Business responses received from the Department after 60 days l 2 Business Error responses received from the Department after 30 days on The results set. TransactionID This value will be reflected in the DATA_RESPONSE message. OPTIONAL. 01 The client may send a DATA_REQUEST message if it has not received a reply from the Gateway after the PollInterval timeout value supplied on the previous Gateway message (SUBMISSION_ACKNOWLEDGEMENT. Identifies the class of XML document being queried. is OPTIONAL. where element is present.gov. For ISV Test Service.8 DATA_REQUEST Message Source/Destination Portal/Client application to Gateway Processing The DATA_REQUEST message enables a client to request the details of the document submissions that the Gateway is currently handling for them. w EnvelopeVersion MANDATORY. Documents that have ov been deleted from the Gateway will not appear in the DATA_RESPONSE. Non-Protectively Marked UK Government Gateway Document Submission Protocol 3. Version 3. w MessageDetails MANDATORY. b pu Function MANDATORY. Transformation MANDATORY. Set to list. For live submissions.32}). n aw Message Structure dr GovTalkMessage MANDATORY. Set to request. to that type of document. The client can also indicate date/time ranges to further narrow the search. or to 1. r2 SUBMISSION_RESPONSE or ERROR_RESPONSE) has expired. as Header MANDATORY. Set to 2. produced by a DATA_REQUEST will be contained in the body elements of a DATA_RESPONSE message. lic Qualifier MANDATORY. If present must conform to the XSD pattern defined in Th the GovTalk envelope specification ([0-9A-F]{0. It is recommended this value maintains uniqueness to assist the client with interpreting a response from Gateway.govtalk. The DATA_RESPONSE message returned from the Gateway will list the documents that matched the criteria in em the DATA_REQUEST.1 Page 33 of 47 Published Date: 06/03/08 . Set to XML.

of the format dd/mm/yyyy. on MANDATORY. of the format hh:mm:ss. Otherwise it contains no sub-elements. MANDATORY. MANDATORY. Any Key elements will be ignored. w GovTalkErrors OPTIONAL. this element can (but does not need to) lic be scoped by a different namespace. May be populated with any Date/Time constraints for the query and whether to return identifier information. Non-Protectively Marked UK Government Gateway Document Submission Protocol GatewayTimestamp OPTIONAL. dr GovTalkDetails MANDATORY. OPTIONAL. Must be populated with the XML node structure n necessary to provide a valid digital signature block. urn:gateway/statusrequest.1 Page 34 of 47 Published Date: 06/03/08 . If included. Set to supplied client account name. Element must be empty.e in the SenderDetails SUBMISSION_REQUEST message) then these same credentials must be are provided here. Method MANDATORY. If the value of the Method element is MD5 then Value is be Value calculated from the clear password by: 1. Set to a valid date. If the Portal/client application provided credentials when the original document was submitted (i. Set to a valid date. Body n Note: If Body element is not included all document submissions io for the specified class will be returned. ith Keys MANDATORY. It is recommended that this element is not present. Signature (Section 5) aw See the W3C signing documentation on the W3C site (http://www. For username / password authentication the following elements must be set within the SenderDetails/IDAuthentication block: SenderID MANDATORY. Set to a valid time. StartDate OPTIONAL.w3. Converting to lower case and UTF-8 encoding em 2. Note: For backward compatibility this element can be omitted and identifier information will NOT be returned. Th If set to a value of 1 the DATA_RESPONSE message will return identifier information for outstanding submissions. 7. as w OPTIONAL. Set to W3Csigned. If this Version 3. StatusRequest b Note: If this element is not included the subordinate elements pu below can still be included directly in the Body (see example). If this StartTime element is used a valid StartDate must also be set. of the format dd/mm/yyyy. MD5 hashing ov 3.org/TR/xmldsig-core). is OPTIONAL. IncludeIdentifiers If set to a value of 0 the DATA_RESPONSE message will NOT return identifier information for outstanding submissions. 01 If the value of the Method element is clear then Value must r2 contain a clear text password. Set to MD5 or clear. at OPTIONAL. Base64 encoding N For digital signature authentication the following elements must be set: Method 2 MANDATORY. If included must have a value of 0 or 1. OPTIONAL.

OPTIONAL. 7.0</EnvelopeVersion> <Header> <MessageDetails> em <Class>MOSWTSC2</Class> <Qualifier>request</Qualifier> <Function>list</Function> ov <CorrelationID/> <Transformation>XML</Transformation> N </MessageDetails> <SenderDetails> <IDAuthentication> <SenderID>VendorID</SenderID> 2 on <Authentication> <Method>MD5</Method> <Value>fSgjkCA3I9k/J24Y5M3qhuQs=</Value> n </Authentication> aw </IDAuthentication> </SenderDetails> </Header> dr <GovTalkDetails> <Keys/> ith </GovTalkDetails> <Body> w <IncludeIdentifiers>1</IncludeIdentifier> <StartDate>13/11/2006</StartDate> as <StartTime>16:00:00</StartTime> <EndDate>13/11/2006</StartDate> <EndTime>16:30:00</EndTime> w </Body> </GovTalkMessage> n io at b lic pu is Th Version 3. If this element is used a valid EndDate must also be set. Set to a valid time of the format hh:mm:ss.uk/CM/envelope"> be <EnvelopeVersion>2. Samples The mandatory elements within the following sample data request are shown in bold while optional elements appear in normal type.0"?> <GovTalkMessage xmlns="http://www. 01 r2 <?xml version="1. If the same EndTime start and end date are used this time must be later than the start time.gov.govtalk. Non-Protectively Marked UK Government Gateway Document Submission Protocol element is used a valid StartDate must also be set which must be EndDate earlier than or the same as the value in EndDate.1 Page 35 of 47 Published Date: 06/03/08 .

n io CorrelationID MANDATORY.0 or 1. Element will be empty. be Message Structure em GovTalkMessage MANDATORY. b ResponseEndPoint Note: This element and its value has no significance here and pu should be ignored. w Function MANDATORY. Contains the time the message was generated. Keys MANDATORY. 01 Note: Documents whose resources have been deleted from the Gateway cannot be seen even if a time r2 window is specified. Element will be empty.gov.0 to mirror the EnvelopVersion value EnvelopeVersion in the associated DATA_REQUEST.9 DATA_RESPONSE Message Source/Destination Gateway to Portal/Client application Processing The DATA_RESPONSE message is returned from the Gateway in response to a DATA_REQUEST message from the client. The PollInterval attribute is set to a non-negative integer. Identifies the class of XML document being queried – Class dr supplied in the DATA_REQUEST. If DATA_REQUEST supplied a TransactionID it will be w TransactionID returned in this element. Non-Protectively Marked UK Government Gateway Document Submission Protocol 3.1 Page 36 of 47 Published Date: 06/03/08 . ith Qualifier MANDATORY. Contains a valid HTTP end-point address. at lic MANDATORY. GovTalkDetails MANDATORY. if any. N MANDATORY. A default namespace specified as ov “http://www. is GatewayTimestamp MANDATORY.uk/CM/envelope”. 7. aw MANDATORY. The results set. if the response is an error the response message will be in the format of the submission error message described in the SUBMISSION_ERROR. Set to 2. Th SenderDetails MANDATORY. as MANDATORY. Header element for report results Version 3. n MessageDetails MANDATORY. Set to list. StatusReport MANDATORY. produced will be contained in the Body elements of a DATA_RESPONSE message. Key elements will not be present. Body MANDATORY. Set to response. May contain data. 2 on Header MANDATORY.govtalk. However.

01 r2 MANDATORY. End date and time for report. CorrelationID for message upon which reported CorrelationID status change occurred.uk/CM/envelope"> <EnvelopeVersion>1.govtalk. TransactionID if supplied in SUBMISSION_REQUEST TransactionID message. This element is present if the IncludeIdentifiers element in the DATA_REQUEST message has a value of 1. be em OPTIONAL.gov. 2 on MANDATORY.0"?> <GovTalkMessage xmlns="http://www. Can be empty. Can be empty. Date and time when the message was originally TimeStamp received. n Will be one of the following: aw l SUBMISSION_ACKNOWLEDGE (the document has been acknowledged by the Gateway and is awaiting processing dr by the Government Department) Status ith l SUBMISSION_ERROR (the document was submitted and found to be in error) w l SUBMISSION_RESPONSE (the document has completed as processing and is awaiting client SUBMISSION_POLL/DELETE_REQUEST) w n io at Samples lic The mandatory elements within the following sample data response are shown in bold while optional b elements appear in normal type. if the IncludeIdentifiers element N is not included in the DATA_REQUEST message. Non-Protectively Marked UK Government Gateway Document Submission Protocol SenderID MANDATORY. Starting date and time for report. ov Identifiers Note: For backward compatibility. Latest status change recorded for a given message. This Identifiers element includes one or more Identifier sub-elements. Included if any results are returned. Can be empty StartTimeStamp MANDATORY. EndTimeStamp MANDATORY. 7.gateway. or has a value of 0.1 Page 37 of 47 Published Date: 06/03/08 .345</GatewayTimestamp> </MessageDetails> Version 3. StatusRecord Each Status Record includes the following 5 elements.gov. OPTIONAL. Detailed results.0</EnvelopeVersion> <Header> <MessageDetails> <Class>MOSWTSC2</Class> <Qualifier>response</Qualifier> <Function>list</Function> <TransactionID/> <CorrelationID></CorrelationID> <ResponseEndPoint PollInterval=”2”> https://secure. MANDATORY. this element will not be present. MANDATORY.uk/submission </ResponseEndPoint> <GatewayTimestamp>2006-11-23T11:54:18. pu is Th <?xml version="1. Otherwise it is empty.

21</TimeStamp> r2 <CorrelationID>5317CCA6A1F0444A97B02D85849F5445</CorrelationID> <TransactionID>BCC10045EA5DD441</TransactionID> <Identifiers> be <Identifier Type = “RefNo”>00012235</ Identifier> <Identifiers> em <Status>SUBMISSION_RESPONSE</Status> </StatusRecord> </StatusReport> ov </Body> </GovTalkMessage> N 2 on n aw dr ith w as w n io at b lic pu is Th Version 3.1 Page 38 of 47 Published Date: 06/03/08 . <Status>SUBMISSION_ERROR</Status> </StatusRecord> 01 <StatusRecord> <TimeStamp>13/11/2006 16:26:11.00</StartTimeStamp> <EndTimeStamp>13/11/2006 16:30:00:00</EndTimeStamp> <StatusRecord> <TimeStamp>13/11/2006 16:19:56. Non-Protectively Marked UK Government Gateway Document Submission Protocol <SenderDetails/> </Header> <GovTalkDetails> <Keys/> </GovTalkDetails> <Body> <StatusReport> <SenderID>VendorID</SenderID> <StartTimeStamp>13/11/2006 16:00:00.50</TimeStamp> <CorrelationID>C13C78E280A449E8B0B959FF6AA8125</CorrelationID> <TransactionID>A23EEBF5EA34eAA8</TransactionID> <Identifiers> <Identifier Type = “RefNo”>00012856</ Identifier> <Identifiers> 7.

ith 1038 The submitted document contains an invalid entry for StartDate and/or StartTime. 2005 The Gateway has not received an acknowledgement of your submission from the back-end system within the permitted timescale.1 Page 39 of 47 Published Date: 06/03/08 . Either resubmit or contact the appropriate organisation Version 3. The submitted document contains an entry for CorrelationID. Non-Protectively Marked UK Government Gateway Document Submission Protocol 4 Appendix A: Error-Return Codes Errors Raised by Gateway The actual textural description given by Gateway may include additional verbose information to assist in diagnosing issues. n 1020 This field should be left empty. w The submitted document contains an inconsistent value entry for the specified method. StartDate and w StartTime must precede EndDate and/or EndTime. which is a reserved system field. at 1042 lic The submitted document does not contain a populated Body. If the Function field dr 1035 contains the value delete. If you have not received a response you should resubmit the document. 2002 The document does not contain the minimum required data. em Errors in Submission ov Error N Code Description 1002 2 Authentication Failure. as 1039 The submitted document contains an invalid entry for any one of the following fields StartDate. r2 The submitted XML document either failed to validate against the GovTalk schema for this class 1001 be of document or its body was badly formed. b 1046 Authentication Failure. pu is Th Messages Referring to Gateway Services Error Code Description The Gateway could not locate a record for the supplied correlation ID: the submission may have 2000 been deleted or the correlation ID may be invalid. The digital signature on the submitted document has not been on recognised. The supplied user credentials failed validation for the requested service. EndDate or EndTime. 2001 The document exceeds the maximum permitted size. StartTime. then the CorrelationID field must be populated. The submission of this document has failed due to an internal system error. 01 1000 System failure. Major Errors Error Code Description 7. aw The submitted document contains an invalid entry for CorrelationID. If n 1040 W3Csigned is specified the Value element must be omitted and a Signature block must be io present.

Non-Protectively Marked UK Government Gateway Document Submission Protocol directly to determine if your submission has been accepted. Messages Referring to Target Spoke Services Error Code Description 3000 The processing of your document submission failed.1 Page 40 of 47 Published Date: 06/03/08 . Please re-submit 3001 The submission of this document has failed due to customer specific business logic in the Body element. 7. 01 r2 be em ov N 2 on n aw dr ith w as w n io at b lic pu is Th Version 3.

uk/CM/envelope"> 01 <EnvelopeVersion>2.govtalk.org/2000/09/xmldsig#rsa-sha1"/> <Reference> <Transforms> <Transform Algorithm=“http://www. --> <GovTalkMessage xmlns="http://www.w3.w3.org/2000/09/xmldsig#sha1"/> <DigestValue>ThisIsTheDigestOverTheBody</DigestValue> on </Reference > </SignedInfo> <SignatureValue>ThisIsTheSignedDigestValue</SignatureValue> n <KeyInfo> aw <X509Data> <X509Certificate>ThisIsTheDigitalCertificateOfTheSubmitter<X509Certificate/> dr </X509Data> </KeyInfo> ith </Signature> </Authentication> w </IDAuthentication> </SenderDetails> as </Header> <GovTalkDetails> w </GovTalkDetails> <Body Id="Body"> n </Body> </GovTalkMessage > io at lic This is the legacy signature structure used by older applications – It should not be used by new b implementations.w3.w3.org/2000/09/xmldsig#"> ov <SignedInfo > <CanonicalizationMethod Algorithm="http://www. Non-Protectively Marked UK Government Gateway Document Submission Protocol 5 Appendix B: Digital Signature Authentication Digital Signature Authentication Illustrates the structure of the SenderDetails block when the message Body is digitally signed (i.e. <! -- DigestValue contains the digest of the message Body SignatureValue contains the digital signature of the DigestValue (produced using the submitter’s private key) X509Certificate contains the submitter’s certificate 7. in particular the X509Certificate pu element is not within the Signature block.w3.org/TR/1999/REC-xpath-19991116"> Version 3. is <! -- Th DigestValue contains the digest of the message Body SignatureValue contains the digital signature of the DigestValue (produced using the submitter’s private key) X509Certificate contains the submitter’s certificate --> <SenderDetails> <IDAuthentication> <Authentication> <Method>W3Csigned </Method> <Signature xmlns="http://www.w3.w3.0</EnvelopeVersion> <Header> r2 <MessageDetails> </MessageDetails> be <SenderDetails> <IDAuthentication> <Authentication> em <Method W3Csigned</Method> <Signature xmlns="http://www. As illustrated.1 Page 41 of 47 Published Date: 06/03/08 .w3.org/TR/2000/WD-xml-c14n-20001011"/> <SignatureMethod Algorithm=“http://www.org/TR/2001/REC-xml-c14n-20010315"/> N <SignatureMethod Algorithm=“http://www.org/2000/09/xmldsig#rsa-sha1"/> <Reference URI="#Body"> 2 <DigestMethod Algorithm=" http://www. there are a number of differences. the Method element has a value of W3Csigned).gov.org/2000/09/xmldsig#"> <SignedInfo > <CanonicalizationMethod Algorithm="http://www.

Non-Protectively Marked UK Government Gateway Document Submission Protocol <XPath>/GovTalkMessage/Body</XPath> </Transform> </Transforms> <DigestMethod Algorithm="http://www.org/2000/09/xmldsig#sha1"/> <DigestValue>ThisIsTheDigestOverTheBody</DigestValue> </Reference> </SignedInfo> <SignatureValue>ThisIsTheSignedDigestValue</SignatureValue> </Signature> </Authentication> </IDAuthentication> <X509Certificate>ThisIsTheDigitalCertificateOfTheSubmitter<X509Certificate/> </SenderDetails> 7.w3. 01 r2 be em ov N 2 on n aw dr ith w as w n io at b lic pu is Th Version 3.1 Page 42 of 47 Published Date: 06/03/08 .

uk/CM/core" xmlns:xsd="http://www.w3.govtalk. error.e-envoy.org/TR/XMLSchema --> <xsd:schema targetNamespace="http://www.gov. the header contains a single Erro element of type "business" and the Body contains further information.uk.Developed by Office of the e-Envoy.uk/CM/errorresponse xmlns:gt="http://www.govtalk.1 Page 43 of 47 Published Date: 06/03/08 . response</gt:KeyWords> </xsd:appinfo> </xsd:annotation> r2 <xsd:element name="ErrorResponse"> <xsd:complexType> be <xsd:sequence> <xsd:element ref="err:Application" minOccurs="0"/> em <xsd:element name="Error" maxOccurs="unbounded"> <xsd:complexType> <xsd:sequence> ov <xsd:element name="RaisedBy" type="xsd:string"/> <xsd:element name="Number" type="xsd:integer" minOccurs="0"/> N <xsd:element name="Type" type="xsd:string"/> <xsd:element name="Text" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> 2 <xsd:element name="Location" type="xsd:string" minOccurs="0"/> <xsd:element ref="err:Application" minOccurs="0"/> on </xsd:sequence> </xsd:complexType> </xsd:element> n </xsd:sequence> aw <xsd:attribute name="SchemaVersion" use="required"/> </xsd:complexType> </xsd:element> dr <xsd:element name="Application"> <xsd:complexType> ith <xsd:sequence> <xsd:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> w </xsd:sequence> <xsd:anyAttribute namespace="##any"/> as </xsd:complexType> </xsd:element> w </xsd:schema> n io at b lic pu is Th Version 3.uk/CM/errorresponse" xmlns:err="http://www.</xsd:documentation> 7.0"?> <!-. Conforms to w3c http://www.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified" version="2. <xsd:appinfo> 01 <gt:KeyWords>business.gov. Non-Protectively Marked UK Government Gateway Document Submission Protocol 6 Appendix C: Error-Response Schema (Business Erorrs) Error-Response schema Errors returned in the Body of a Business Error Response message use this schema <?xml version="1.gov.gov.govtalk. In these circumstances.w3.0" id="Error-Response"> <xsd:annotation> <xsd:documentation>This schema is used for errors returned by business systems. www.

01 The test service provides sufficient functionality to enable developers to submit documents and receive reports on their progress through the system in the same way as in the live version of the system. Non-Protectively Marked UK Government Gateway Document Submission Protocol 7 Appendix D: ISV Test Service ISV Test Service The Gateway provides a test service which allows Independent Software Vendors (ISVs) to test their applications.dev. to the rules governing the format of messages that can be accepted by the Gateway. In some cases these be are not consistent with the live Gateway service: em l Test Service is not intended to handle large documents. Support is provided for: l DSP protocol – so applications can submit business transaction (business forms) l WS SOAP Public interface – so applications can. 2 on n aw dr ith w as w n io at b lic pu is Th Version 3. for example.gateway. The test service gives developers the opportunity to test the mechanisms used for communicating with the Gateway before working with the live system. The Test Service imposes a number of constraints on the client document submissions. It also allows developers to test that their applications conform 7.uk/submission. This is not the case for the live system. N From time to time minor discrepancies may occur as the result of ongoing maintenance.gov. Document submissions to the Test Service that are over one megabyte in size will be rejected with an appropriate error message.1 Page 44 of 47 Published Date: 06/03/08 . The test r2 service is located at https://secure. get user details or retrieve service enrolment information. l Submissions to the Test Service that include the optional GatewayTest element must have its value set to "1". ov l Every effort will be made to keep the behaviour of the live Gateway and the Test Service consistent.

Employs the Secure Socket Layer (SSL) protocol to provide a Version 3. as Department) and the central Gateway.e. Specified for each service (based on HMG Authentication Levels. but Gateway adds a level 1.1 Page 45 of 47 Published Date: 06/03/08 . 01 ¡ Type 0: No authentication r2 ¡ Type 1: A valid User ID or valid certificate (though not necessarily known to Gateway) is required be Authentication Level ¡ Type 2: A valid certificate (though not necessarily em known to Gateway) is required l Level 1: At lease a User ID/Password is required to access service transactions/forms ov l Level 1. The b certificate/private key is also used to sign transactions. For example a ith Correlation ID correlation ID is returned in response to a document (form) submission.e. Non-Protectively Marked UK Government Gateway Document Submission Protocol 8 Appendix E: Glossary Term Description The process of validating the credential information (digital Authentication certificate or User ID/password). The owner of the certificate possesses the corresponding private key. 0-63 n in decimal) is converted into a character set comprising of a 64- Base64 Encoding aw character alphabet. is A DRM User can improve operational efficiency by allowing an Th organisation/agent (registered with the Gateway) to use their existing internal user accounts to act on service enrolments – rather than create a (parallel) hierarchy of Gateway User and Assistant accounts to do this work.5: At lease a User ID/Password with security N phrase is required to access service transactions/forms 2 l Level 2 and 3: A certificate is required to access service transactions/forms on Encodes binary values into characters.e.509 digital certificate contains identifying information and a at public key.e. dr A unique identifier assigned by the Gateway. w Provides the interface between the service owner (i. This can be used (in DSP) to poll for the response. n io An X. Additionally a DRM User's authentication credential (i. Each 6-bit value (i. a–z). User ID/password or certificate) can be used in (i. DRM (Delegated Rights Management) A DRM User (created by a existing User in the User organisation/agent) uses the GsoDelegateRights method to temporarily associate internal organisation/agent user accounts with Gateway enrolments that they can then act on. to authorise) DSP submissions. A pu certificate is obtained from a certification authority. numerals (0–9). This alphabet consisting of alphabet characters (A–Z. Any attempt to change information on the certificate will be detected. which proves the certificate (and lic Digital Certificate therefore the information on it) belongs to them. and the "+" and "/" symbols.5): l Level 0: no authentication: 7. Communication with the DIS (Departmental Interface Server) w Gateway uses SOAP reliable messaging and XML GovTalk standards.

A service specifies the minimum authentication level a credential must have to access (see/enrol) in the service.gov. Departments (i. io at An alphanumeric string used in conjunction with a User ID for Password authentication. Local Authorities or other Government Agencies) provide online access to secure is interactive services. A Portal uses the Gateway to register users with Portal the Gateway and enrol them in services. A service represents the lowest level of granularity by which access is Service granted. the known fact values supplied by the user are checked against a reference set of known facts to verify who the user is to the service. For example. a Government Departments.hmrc. Uniquely identifies a user (credential) within a service. ov N Pieces of information required by a service from a user that only the user should know. Consists of a grouping of one or more transactions. and between the Portal and the Gateway. The user chooses the password when their account lic is created b pu A Portal typically refers to a web Portal (i. through the Gateway to HRMC.e. web site). See Authentication level. r2 An ISV application can authenticate a user (i. Local authorities or other authorised organisations. Th through Portals.e. Non-Protectively Marked UK Government Gateway Document Submission Protocol secure HTTP communication channel over the Internet between HTTPS (HyperText Transfer Protocol the user’s computer (browser or application) and the Secure) Portal/Gateway. an accounting or tax self assessment application submitting appropriate business forms 7.for example.g. a PC) that can use. log them on to Gateway) but.e. file a Self Assessment tax return online from the HM Revenue & Customs Web site (http://www. The user (i. 2 During the service enrolment process (or when a user has on forgotten their User ID/password/security phrase).uk). Sage) that runs on a client (e. From the Gateway perspective this is an application (written by an ISV – e. individual. w In a XML schema. This is different to Portals – they can register em users with the Gateway and provide the full set of enrolment functionality offered by the Gateway (SOAP Portal Interface methods).e. because they run in the user environment. distributed known facts) ith which requires the Gateway to send the user supplied values to the appropriate service for checking. Identifiers Identifiers (also referred to keys) for a service are typically a subset of the known facts.1 Page 46 of 47 Published Date: 06/03/08 . Users can then logon to the Portal (i. Version 3. they be have very limited R&E capabilities (they use the SOAP Public Interface methods).e.g.e. The n reference set of known facts can either be: aw Known Facts l Held on the Gateway (i.68 as of the Gateway. previously uploaded to the Gateway from the services) dr l Held by each service (i. as well as generally available information. w Distributed known facts (DKFs) where introduced in release 1. authenticate with the Gateway) and use these services securely to submit business forms . ISV (Independent Software Vendors) organisation user or agent) authentication credentials attached to 01 Application the submitting form will be checked by the Gateway. used to uniquely qualify element names – Names Space thereby avoiding potential name conflicts with elements of n the same name in other XML schemas (vocabularies).e. the facilities offered by the Gateway – in particular the document submission protocol (DSP) to submit transactions/forms to services hosted by government departments.

7. whether they XML Schema are optional or not and the number of times they can be repeated. on n aw dr ith w as w n io at b lic pu is Th Version 3. local authority or other organisation Service Owner responsible for one or more services. ov Describes a particular XML syntax. XML (Extensible Markup Language) validation. transmission. SOAP Public Interface This is restricted to the 'read-only' methods offered by the SOAP Portal Interface.1 Page 47 of 47 Published Date: 06/03/08 . r2 A unique alphanumeric string generated by the Gateway at User ID registration (not selected by the user) that is used in conjunction be with a password for authentication. Core component of the Gateway that and provides an interface to Transaction Engine enable electronic forms and requests to be submitted to service 01 owners. It is used by the HTTPS access method. em A specification designed especially for the definition. SOAP Portal Interface Exposes a full range of methods to be called from a Portal. It defines the structure of the N document in terms of elements and sub-elements. Exposes methods that can be called directly from an application. 2 It also specifies any attributes associated with an element. Non-Protectively Marked UK Government Gateway Document Submission Protocol A government department. and interpretation of data between organisations. Protocol uses Public Key Infrastructure (PKI) technology to provide SSL (Secure Sockets Layer) encrypted communication over the Internet.