Government Gateway Public Methods

Below is an overview of the type of ‘calls’ that can be made to the API portal. For more information and technical help, please see the ISV developer help zip file above.

 

Call

Description

GsoGetAgentDetails

This method gets an agent group’s details.

GsoGetAssignedAgentCredentialsForClientAllocation

This method returns all of the agent credentials that have been assigned to a specified client allocation.

GsoGetAssignedClientAllocationsForAgentCredential

This method returns all client allocations that have been assigned to the specific agent credential.

GsoGetAssignedEnrolments

This method returns all of the enrolments that are assigned to the specified credential.

GsoGetAssignedPeersByEnrolment

This method returns all of the peers that are assigned to a direct enrolment.

GsoGetAssistants

This method returns all the assistants in an organisation.

GsoGetAssistantsByPeer

This method returns all of the assistants for a specified principal or agent User.

GsoGetAverageTransactionTimes

This method returns the average response time for documents, of the specified message type, submitted through the Gateway Transaction Engine.

GsoGetClientAllocationList

This method returns all of the client allocations for an agent group.

GsoGetEligibleService

This method checks if the calling credential is eligible for an enrolment in the specified service.

GsoGetEligibleServices

This method returns all of the services the principal of agent User is eligible to enrol in.

GsoGetEligibleServicesByServiceOwner

This method returns a set of services that the caller is eligible to enrol in, filtered by a single service owner.

GsoGetEnrolment

This method returns the details of an existing direct enrolment.

GsoGetEnrolments

This method returns a list of all the direct enrolments for the caller/callers organisation.

GsoGetEnrolmentsByService

This method returns a list of the direct enrolments in the specified service for the caller/callers organisation.

GsoGetOrphanedAssistants

This method returns all orphaned assistants for the calling credentials organisation.

GsoGetPeerDetails

This method returns the basic details about a principal or agent User.

GsoGetPeers

The method returns all peers in the calling credentials organisation.

GsoGetServiceInfo

This method returns details information about the specified service. This includes Identifier, Known Fact and Service Transaction information.

GsoGetUserDetails

This method gets the calling credentials details.