Glossary Item Box

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

# Gateway Additions

This illustrates the Submitter section of the GatewayAdditions block within the GovTalk envelope. This information is produced by the Gateway and added to SUBMISSION_REQUEST messages before forwarding the message to the back-end.

# Schema

This is the schema for the Submitter section of the GatewayAdditions block
?xml version= "1.0" encoding="UTF-8"?> <xs:schema targetNamespace="http://www.govtalk.gov.uk/gateway/submitterdetails" xmlns="http://www.govtalk.gov.uk/gateway/submitterdetails" xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="Submitter"> <xs:complexType> <xs:sequence> <xs:element name="AgentDetails"> <xs:complexType> < xs:sequence > <xs:element name="AuthenticationType" type="xs:integer"/> <xs:element name="AgentGroupCode" type="AgentCodeTYPE"/> <xs:element name="AgentEnrolments"> <s:complexType> <xs:sequence> <xs:element name= "Enrolment" maxOccurs=" unbounded"> <xs:complexType> <xs:sequence > <xs:element name="ServiceName" type="ServiceNameTYPE"/> <xs:element name="Identifiers"> <xs:complexType> <xs:sequence> <xs:element name="Identifier" maxOccurs=" unbounded" type=" IdentifierTYPE"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="SubmitterDetails"> <xs:complexType> <xs:sequence> <xs:element name= "RegistrationCategory" type="RegistrationCategoryTYPE"/> <xs:element name="UserType" type="UserTypeTYPE"/> <xs:element name="CredentialRole" type="CredentialRoleTYPE"/> <xs:element name="CredentialIdentifier" type="CredentialIdentifierTYPE"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <xs:simpleType name="AgentCodeTYPE"> <xs:restriction base="xs:string"> <xs:length value="12"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="ServiceNameTYPE"> <xs:restriction base="xs:string"> <xs:maxLength value="50"/> <xs:minLength value="1"/> </xs:restriction> <xs:simpleType> <xs:complexType name="IdentifierTYPE"> <xs:simpleContent> <xs:extension base="IdentifierValueTYPE"> <xs:attribute name="IdentifierType" type="IdentifierTypeTYPE" use="required"/> </xs:extension> </xs:simpleContent> </xs:complexType> <xs:simpleType name="IdentifierValueTYPE"> <xs:restriction base="xs:string"> <xs:maxLength value="50"/> <xs:pattern value="[\p{L}\p{Nd}_\-\(\)\{\}/]*"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="IdentifierTypeTYPE"> <xs:restriction base="xs:string"> <xs:maxLength value="40"/> <xs:minLength value="1"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="RegistrationCategoryTYPE"> <xs:restriction base="xs:string"> <xs:enumeration value="Individual"/> <xs:enumeration value="Organisation"/> <xs:enumeration value="Gov-Individual"/> <xs:enumeration value="Gov-Organisation"/> <xs:enumeration value="Agent"/> <xs:enumeration value="Spoke"/> </xs:restriction> </xs:simpleType> < xs:simpleType name = "UserTypeTYPE"> <xs:restriction base="xs:string"> <xs:enumeration value="Principal" /> <xs:enumeration value="Agent"/> <xs:enumeration value="Spoke"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="CredentialRoleTYPE"> <xs:restriction base="xs:string"> <xs:enumeration value="User"/> <xs:enumeration value="Assistant" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="CredentialIdentifierTYPE"> <xs:restriction base="xs:string"> <xs:minLength value="1"/> <xs:maxLength value="38"/> </xs:restriction> </xs:simpleType> </ xs:schema>

# Samples

For hub and spoke this is the typical scenario. A Spoke Admin User submitting a transaction for one of their own enrolments (i.e. RegistrationCaterory is Spoke and AgentDetails is empty).
<GatewayAdditions > <Submitter xmlns="http://www.govtalk.gov.uk/gateway/submitterdetails"> <AgentDetails/> <SubmitterDetails> <RegistrationCategory>Spoke</RegistrationCategory> <UserType>Spoke</UserType > <CredentialRole>User</CredentialRole > <CredentialIdentifier>0000093649573755</CredentialIdentifier> </SubmitterDetails> </Submitter> </GatewayAdditions>

An Organisation User submitting a transaction for one of their own enrolments (i.e. RegistrationCaterory is Organisation and AgentDetails is empty).
<GatewayAdditions> <Submitter xmlns="http://www.govtalk.gov.uk/gateway/submitterdetails"> <AgentDetails/> <SubmitterDetails> <RegistrationCategory>Organisation</RegistrationCategory> <UserType>Principal</UserType > <CredentialRole>User</CredentialRole > <CredentialIdentifier>0000093649573538</CredentialIdentifier> </SubmitterDetails> </Submitter> </GatewayAdditions>

> An Agent Assistant submitting on behalf of a principal, where the principal is enrolled but not allocated.
> <! -- AuthenticationType: 0 - Principal Enrolled and Submitter Allocated and Assigned 1 - Principal Enrolled Only 2 - Principal Known Facts only --> <GatewayAdditions> <Submitter xmlns="http://www.govtalk.gov.uk/gateway/submitterdetails"> <AgentDetails> <AuthenticationType>1</AuthenticationType> <AgentGroupCode>JQ8AUJ33BVHC </AgentGroupCode> <AgentEnrolments> <Enrolment > <ServiceName>MOSW5AS</ServiceName> <Identifiers> <Identifier IdentifierType="MOSW5PostCode">NW44UB</Identifier> </Identifiers> </Enrolment> </AgentEnrolments> </AgentDetails> <SubmitterDetails> <RegistrationCategory>Agent</RegistrationCategory> <UserType>Agent</UserType > <CredentialRole>Assistant</CredentialRole> < CredentialIdentifier>0000001223179602</CredentialIdentifier> </SubmitterDetails > </Submitter > </GatewayAdditions >

> Illustrates the situation where an agent has enrolled in more than one agent service that map to the same client service. In this case all the possible agent service enrolments that could have been used to authorise the submission are listed.
> <! -- AuthenticationType: 0 - Principal Enrolled and Submitter Allocated and Assigned 1 - Principal Enrolled Only 2 - Principal Known Facts only --> <GatewayAdditions> <Submitter xmlns="http://www.govtalk.gov.uk/gateway/submitterdetails"> <AgentDetails> <AuthenticationType>1</AuthenticationType> <AgentGroupCode>JQ8AUJ33BVHC</AgentGroupCode > <AgentEnrolments> <Enrolment> <ServiceName>MOSW5AS</ServiceName> <Identifiers> <Identifier IdentifierType="MOSW5ASPostCode">NW44UB</Identifier> </Identifiers> </Enrolment> <Enrolment> <ServiceName>MOSW6AS</ServiceName> <Identifiers> <Identifier IdentifierType="MOSW6ASPostCode">NW44UB</Identifier> </Identifiers> </Enrolment> </AgentEnrolments> </AgentDetails> <SubmitterDetails > <RegistrationCategory>Agent</RegistrationCategory> <UserType>Agent</UserType> <CredentialRole>Assistant</CredentialRole> <CredentialIdentifier>0000001223179602</CredentialIdentifier> </SubmitterDetails> </Submitter> </GatewayAdditions>

© Crown Copyright 2008. All rights reserved