Glossary Item Box

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

# Allocating Principal Enrolments

# How to Allocate a Principal Enrolment

A principal can allocate an enrolment in a service to an agent organisation (enrolled in an associated agent service) using the SOAP Portal Interface "allocate agent" method. This is called a client allocation. If the agent organisation has only a single agent user (or a single agent user/assistant assigned to work with this service), then this agent user is automatically assigned the client allocation, otherwise it is left unassigned. The agent user can then act on behalf of the principal user. Note that this method requires the agent's unique AgentCode; this is not available programmatically through the Gateway and must be obtained in some other way from the agent.

To find out more about agent organisations and allocating and assigning client allocations see Organisations, Users and Assistants.

If the service flag AgentExcludesPrincipal is set then the agent has exclusive use of the enrolment (i.e. only it can interact with, and send business forms to the service), otherwise the principal and the agent are both able to use the enrolment.

If the service flag ExclusiveAgent is set the principal may only assign their enrolment to one agent organisation – this is the normal situation.

Note: Service Owners (Admin users) can also allocate an enrolment (a client allocation) to an agent group using the SOAP Admin Interface.

© Crown Copyright 2008. All rights reserved