Package com.fifa.connectid.sdk.core

Interface FifaConnectIdClient

All Known Implementing Classes:

FifaConnectIdClientImpl

public interface FifaConnectIdClient

Client used to make request to FIFA Connect ID service. One instance allows to make multiple requests.

Method Summary

Modifier and Type	Method	Description
PersonType	addRegistrations(AddRegistrationsRequestType request, Boolean force)	Adds person registrations
BulkDeactivateRegistrationsResponseType	bulkDeactivateRegistrations(BulkDeactivateRegistrationsRequestType request)	Bulk deactivate registrations given in request.
FindFacilitiesResponseType	findFacilities(FindFacilitiesRequestType request)	Searches for facilities.
FindOrganisationsResponseType	findOrganisations(FindOrganisationsRequestType request)	Searches for organisations.
String	forceRegisterPerson(PersonData personData)	Registers a new person even if possible duplicates are found.
String	forceRegisterPerson(PersonData personData, String personLocalId)	Registers a new person even if possible duplicates are found.
NationalAssociationsOnboardedResponseType	getAllNationalAssociationsOnboardedStatus()	Asks Connect ID if specific organisation is onboarded.
List<String>	getDataHoldersOfPerson(String personFifaId)	Gets systems registered as Data Holder for the given person
FacilityLocalType	getFacility(String facilityFifaId)	Gets facility data associated with the specified FIFA Unique Identifier.
List<FacilityLocalType>	getFacilityDuplicates(FacilityLocalType facility)	Gets a list of facilities this facility may be duplicated with.
HashingServiceClient	getHashingClient()	Returns current instance of HashingClient
IdDirectoryServiceClient	getIdDirectoryClient()	Returns current instance of IdDirectoryClient
MemberAssociationResponseType	getMemberAssociationForFifaId(String organisationFifaId)	Gets FIFA Id and short name of the Member Association the searched organisation belongs to.
List<String>	getMergedSecondaryFifaIdsForPerson(String personFifaId)	Gets secondary FIFA IDs directly merged into person
NationalAssociationsOnboardedResponseType	getNationalAssociationsOnboardedStatus(NationalAssociationsOnboardedRequestType request)	Asks Connect ID if specific organisation is onboarded.
OrganisationLocalType	getOrganisation(String organisationFifaId)	Gets organisation data associated with the specified FIFA Unique Identifier.
List<OrganisationLocalType>	getOrganisationDuplicates(OrganisationLocalType organisation)	Gets a list of organisations this organisation may be duplicated with.
PersonType	getPerson(String personFifaId)	Gets person data associated with the specified FIFA Unique Identifier.
List<PersonDuplicateType>	getPersonDuplicates(PersonData personData)	Gets a list of people this person may be duplicated with.
List<PersonDuplicateType>	getPersonDuplicates(PersonData personData, List<String> organisationsIds)	Gets a list of people this person may be duplicated with.
GetDuplicatesOfRegisteredPersonResponseType	getPersonDuplicatesExceptTrustedKnownDuplicates(String personFifaId, List<String> trustedOrganisationsIds)	Gets a list of people this person may be duplicated with.
RegistrationType	getPrimaryDataProviderRegistrationType(String personFifaId)	Gets registration belonging to the primary data provider of the person with the specified FIFA Unique Identifier.
OrganisationLocalType	mergeOrganisations(String primaryOrganisationFifaId, String secondaryOrganisationFifaId)	Merges two organisations.
PersonType	mergePersons(String primaryPersonId, String secondaryPersonId)	Merges two persons.
void	registerAsDataHolderOfPerson(String personFifaId)	Registers current system as Data Holder for the given person
String	registerFacility(FacilityLocalType facility)	Registers a new facility and assigns FIFA Unique Identifier.
String	registerFacility(FacilityLocalType facility, Boolean force)	Registers a new facility and assigns FIFA Unique Identifier.
String	registerOrganisation(OrganisationLocalType organisation)	Registers a new organisation and assigns FIFA Unique Identifier.
String	registerOrganisation(OrganisationLocalType organisation, Boolean force)	Registers a new organisation and assigns FIFA Unique Identifier.
String	registerPerson(PersonData personData)	Registers a new person and assigns FIFA Unique Identifier.
String	registerPerson(PersonData personData, String personLocalId)	Registers a new person and assigns FIFA Unique Identifier.
OrganisationLocalType	unmergeOrganisations(String primaryOrganisationFifaId, String secondaryOrganisationFifaId)	Reverts merge operation.
PersonType	unmergePersons(String primaryPersonId, String secondaryPersonId)	Reverts merge operation.
FacilityLocalType	updateFacility(FacilityLocalType facility)	Updates the facility.
FacilityLocalType	updateFacility(FacilityLocalType facility, Boolean force)	Updates the facility.
OrganisationLocalType	updateOrganisation(OrganisationLocalType organisation)	Updates the organisation.
OrganisationLocalType	updateOrganisation(OrganisationLocalType organisation, Boolean force)	Updates the organisation.
PersonType	updatePerson(String personId, List<PersonName> names, org.joda.time.LocalDate dateOfBirth, boolean force)	Updates person data.
PersonType	updatePerson(String personId, List<PersonName> names, org.joda.time.LocalDate dateOfBirth, String gender, boolean force)	Updates person data.
PersonType	updateRegistrations(UpdateRegistrationsRequestType request, Boolean force)	Updates person registrations

Method Detail

getPerson

PersonType getPerson(String personFifaId)
              throws FifaConnectIdException,
                     com.fifa.connectservicebus.sdk.AuthenticationException,
                     UnauthorizedException,
                     FifaEntityNotFoundException,
                     InvalidClientDataException,
                     FifaEntityDeletedException,
                     ValidationException

Gets person data associated with the specified FIFA Unique Identifier.

Parameters:

personFifaId - FIFA Unique Identifier.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

FifaPersonMergedException

ValidationException

TooManyRequestsException

FifaEntityDeletedException

getPrimaryDataProviderRegistrationType

RegistrationType getPrimaryDataProviderRegistrationType(String personFifaId)
                                                 throws FifaConnectIdException,
                                                        com.fifa.connectservicebus.sdk.AuthenticationException,
                                                        UnauthorizedException,
                                                        FifaEntityNotFoundException,
                                                        InvalidClientDataException,
                                                        FifaEntityDeletedException,
                                                        ValidationException

Gets registration belonging to the primary data provider of the person with the specified FIFA Unique Identifier.

Parameters:

personFifaId - FIFA Unique Identifier.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

FifaPersonMergedException

ValidationException

TooManyRequestsException

FifaEntityDeletedException

getPersonDuplicates

List<PersonDuplicateType> getPersonDuplicates(PersonData personData)
                                       throws FifaConnectIdException,
                                              com.fifa.connectservicebus.sdk.AuthenticationException,
                                              UnauthorizedException,
                                              ValidationException

Gets a list of people this person may be duplicated with. Uses 'PersonLocalType' as defined in FIFA Data Standard.

Parameters:

personData - - object containing information about local and international names of the person, as well as the date of birth.

Throws:

InvalidClientDataException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

getPersonDuplicates

List<PersonDuplicateType> getPersonDuplicates(PersonData personData,
                                              List<String> organisationsIds)
                                       throws FifaConnectIdException,
                                              com.fifa.connectservicebus.sdk.AuthenticationException,
                                              UnauthorizedException,
                                              ValidationException

Gets a list of people this person may be duplicated with. Uses 'PersonLocalType' as defined in FIFA Data Standard.

Parameters:

personData - - object containing information about local and international names of the person, as well as the date of birth.

organisationsIds - - organisations' FIFA Unique Identifiers

Throws:

InvalidClientDataException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

getPersonDuplicatesExceptTrustedKnownDuplicates

GetDuplicatesOfRegisteredPersonResponseType getPersonDuplicatesExceptTrustedKnownDuplicates(String personFifaId,
                                                                                            List<String> trustedOrganisationsIds)
                                                                                     throws FifaConnectIdException,
                                                                                            com.fifa.connectservicebus.sdk.AuthenticationException,
                                                                                            UnauthorizedException,
                                                                                            InvalidClientDataException,
                                                                                            ValidationException

Gets a list of people this person may be duplicated with. Duplicates marked as known duplicate by trusted organisations would not be returned.

Parameters:

personFifaId - - Person FIFA Unique Identifier.

trustedOrganisationsIds - - Trusted organisations' FIFA Unique Identifiers.

Throws:

InvalidClientDataException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

getOrganisationDuplicates

List<OrganisationLocalType> getOrganisationDuplicates(OrganisationLocalType organisation)
                                               throws FifaConnectIdException,
                                                      com.fifa.connectservicebus.sdk.AuthenticationException,
                                                      UnauthorizedException,
                                                      ValidationException

Gets a list of organisations this organisation may be duplicated with. Uses 'OrganisationLocal' as defined in FIFA Data Standard.

Parameters:

organisation - - object containing information about organisation

Throws:

InvalidClientDataException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

getFacilityDuplicates

List<FacilityLocalType> getFacilityDuplicates(FacilityLocalType facility)
                                       throws FifaConnectIdException,
                                              com.fifa.connectservicebus.sdk.AuthenticationException,
                                              UnauthorizedException,
                                              ValidationException

Gets a list of facilities this facility may be duplicated with. Uses 'FacilityType' as defined in FIFA Data Standard.

Parameters:

facility - - object containing information about facility

Throws:

InvalidClientDataException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

registerPerson

String registerPerson(PersonData personData)
               throws FifaConnectIdException,
                      com.fifa.connectservicebus.sdk.AuthenticationException,
                      UnauthorizedException,
                      InvalidClientDataException,
                      FifaDuplicatedPersonFoundException,
                      ValidationException

Registers a new person and assigns FIFA Unique Identifier. If duplicates are found the person is not registered. Uses 'PersonLocalType' as defined in FIFA Data Standard.

Parameters:

personData - - object containing information about local and international names of the person, as well as the date of birth.

Throws:

InvalidClientDataException

FifaDuplicatedPersonFoundException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

registerPerson

String registerPerson(PersonData personData,
                      String personLocalId)
               throws FifaConnectIdException,
                      com.fifa.connectservicebus.sdk.AuthenticationException,
                      UnauthorizedException,
                      InvalidClientDataException,
                      FifaDuplicatedPersonFoundException,
                      ValidationException

Registers a new person and assigns FIFA Unique Identifier. If duplicates are found the person is not registered. Uses 'PersonLocalType' as defined in FIFA Data Standard.

Parameters:

personData - - object containing information about local and international names of the person, as well as the date of birth.

personLocalId -

Throws:

InvalidClientDataException

FifaDuplicatedPersonFoundException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

forceRegisterPerson

String forceRegisterPerson(PersonData personData)
                    throws FifaConnectIdException,
                           com.fifa.connectservicebus.sdk.AuthenticationException,
                           UnauthorizedException,
                           InvalidClientDataException,
                           ValidationException

Registers a new person even if possible duplicates are found. Uses 'PersonLocalType' as defined in FIFA Data Standard.

Parameters:

personData - - object containing information about local and international names of the person, as well as the date of birth.

Throws:

InvalidClientDataException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

forceRegisterPerson

String forceRegisterPerson(PersonData personData,
                           String personLocalId)
                    throws FifaConnectIdException,
                           com.fifa.connectservicebus.sdk.AuthenticationException,
                           UnauthorizedException,
                           InvalidClientDataException,
                           ValidationException

Registers a new person even if possible duplicates are found. Uses 'PersonLocalType' as defined in FIFA Data Standard.

Parameters:

personData - - object containing information about local and international names of the person, as well as the date of birth.

personLocalId - - Local identifier of person

Throws:

InvalidClientDataException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

updatePerson

PersonType updatePerson(String personId,
                        List<PersonName> names,
                        org.joda.time.LocalDate dateOfBirth,
                        boolean force)
                 throws com.fifa.connectservicebus.sdk.AuthenticationException,
                        FifaDuplicateOfRegisteredPersonFoundException,
                        FifaConnectIdException,
                        UnauthorizedException,
                        ValidationException

Updates person data.

Parameters:

personId - Fifa Identifier of person

names - Person names that need to be updated

dateOfBirth - Person date of birth that need to be updated

force - - when set to true updates a person even if possible duplicates are found

Throws:

InvalidClientDataException

FifaDuplicateOfRegisteredPersonFoundException

FifaConnectIdException

FifaEntityNotFoundException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

updatePerson

PersonType updatePerson(String personId,
                        List<PersonName> names,
                        org.joda.time.LocalDate dateOfBirth,
                        String gender,
                        boolean force)
                 throws com.fifa.connectservicebus.sdk.AuthenticationException,
                        FifaDuplicateOfRegisteredPersonFoundException,
                        FifaConnectIdException,
                        UnauthorizedException,
                        ValidationException

Updates person data.

Parameters:

personId - Fifa Identifier of person

names - Person names that need to be updated

dateOfBirth - Person date of birth that need to be updated

force - - when set to true updates a person even if possible duplicates are found

gender - Sex of a person

Throws:

InvalidClientDataException

FifaDuplicateOfRegisteredPersonFoundException

FifaConnectIdException

FifaEntityNotFoundException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

addRegistrations

PersonType addRegistrations(AddRegistrationsRequestType request,
                            Boolean force)
                     throws FifaConnectIdException,
                            com.fifa.connectservicebus.sdk.AuthenticationException,
                            UnauthorizedException,
                            InvalidClientDataException,
                            FifaEntityNotFoundException,
                            ValidationException

Adds person registrations

Parameters:

request - - object containing registration information

force - - when set to true validation of acting organisation will not be checked.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

updateRegistrations

PersonType updateRegistrations(UpdateRegistrationsRequestType request,
                               Boolean force)
                        throws FifaConnectIdException,
                               com.fifa.connectservicebus.sdk.AuthenticationException,
                               UnauthorizedException,
                               InvalidClientDataException,
                               FifaEntityNotFoundException,
                               ValidationException

Updates person registrations

Parameters:

request - - object containing registration information

force - - when set to true validation of acting organisation will not be checked.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

getOrganisation

OrganisationLocalType getOrganisation(String organisationFifaId)
                               throws FifaConnectIdException,
                                      com.fifa.connectservicebus.sdk.AuthenticationException,
                                      UnauthorizedException,
                                      FifaOrganisationMergedException,
                                      FifaEntityNotFoundException,
                                      InvalidClientDataException,
                                      ValidationException

Gets organisation data associated with the specified FIFA Unique Identifier.

Parameters:

organisationFifaId - FIFA Unique Identifier.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaOrganisationMergedException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

registerOrganisation

String registerOrganisation(OrganisationLocalType organisation,
                            Boolean force)
                     throws FifaConnectIdException,
                            com.fifa.connectservicebus.sdk.AuthenticationException,
                            FifaDuplicatedOrganisationFoundException,
                            UnauthorizedException,
                            InvalidClientDataException,
                            ValidationException

Registers a new organisation and assigns FIFA Unique Identifier. Uses organisation data as defined in FIFA Data Standard.

Parameters:

organisation - - object containing information about the organisation.

force - - force register organisation

Throws:

InvalidClientDataException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

FifaDuplicatedOrganisationFoundException

ValidationException

TooManyRequestsException

registerOrganisation

String registerOrganisation(OrganisationLocalType organisation)
                     throws FifaConnectIdException,
                            com.fifa.connectservicebus.sdk.AuthenticationException,
                            FifaDuplicatedOrganisationFoundException,
                            UnauthorizedException,
                            InvalidClientDataException,
                            ValidationException

Registers a new organisation and assigns FIFA Unique Identifier. Uses organisation data as defined in FIFA Data Standard.

Parameters:

organisation - - object containing information about the organisation.

Throws:

InvalidClientDataException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

FifaDuplicatedOrganisationFoundException

ValidationException

TooManyRequestsException

mergePersons

PersonType mergePersons(String primaryPersonId,
                        String secondaryPersonId)
                 throws FifaConnectIdException,
                        FifaConflictException,
                        com.fifa.connectservicebus.sdk.AuthenticationException,
                        UnauthorizedException,
                        InvalidClientDataException,
                        FifaEntityNotFoundException,
                        ValidationException

Merges two persons. Returns the primary person.

Parameters:

primaryPersonId - Primary person FIFA Unique Identifier

secondaryPersonId - Secondary person FIFA Unique Identifier

Throws:

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

InvalidClientDataException

FifaEntityNotFoundException

FifaConflictException

ValidationException

TooManyRequestsException

unmergePersons

PersonType unmergePersons(String primaryPersonId,
                          String secondaryPersonId)
                   throws FifaConnectIdException,
                          FifaConflictException,
                          com.fifa.connectservicebus.sdk.AuthenticationException,
                          UnauthorizedException,
                          InvalidClientDataException,
                          FifaEntityNotFoundException,
                          ValidationException

Reverts merge operation. Returns the secondary person which will be active again when unmerge operations is completed.

Parameters:

primaryPersonId - Primary person FIFA Unique Identifier

secondaryPersonId - Secondary person FIFA Unique Identifier

Throws:

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

InvalidClientDataException

FifaEntityNotFoundException

FifaConflictException

ValidationException

TooManyRequestsException

bulkDeactivateRegistrations

BulkDeactivateRegistrationsResponseType bulkDeactivateRegistrations(BulkDeactivateRegistrationsRequestType request)
                                                             throws FifaConnectIdException,
                                                                    InvalidClientDataException,
                                                                    com.fifa.connectservicebus.sdk.AuthenticationException,
                                                                    UnauthorizedException,
                                                                    ValidationException

Bulk deactivate registrations given in request.

Parameters:

request -

Throws:

FifaConnectIdException

InvalidClientDataException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

mergeOrganisations

OrganisationLocalType mergeOrganisations(String primaryOrganisationFifaId,
                                         String secondaryOrganisationFifaId)
                                  throws FifaConnectIdException,
                                         FifaConflictException,
                                         com.fifa.connectservicebus.sdk.AuthenticationException,
                                         UnauthorizedException,
                                         InvalidClientDataException,
                                         FifaEntityNotFoundException,
                                         ValidationException

Merges two organisations. Returns the primary organisation.

Parameters:

primaryOrganisationFifaId - Primary organisation FIFA Unique Identifier

secondaryOrganisationFifaId - Secondary organisation FIFA Unique Identifier

Throws:

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

InvalidClientDataException

FifaEntityNotFoundException

FifaConflictException

ValidationException

TooManyRequestsException

unmergeOrganisations

OrganisationLocalType unmergeOrganisations(String primaryOrganisationFifaId,
                                           String secondaryOrganisationFifaId)
                                    throws FifaConnectIdException,
                                           FifaConflictException,
                                           com.fifa.connectservicebus.sdk.AuthenticationException,
                                           UnauthorizedException,
                                           InvalidClientDataException,
                                           FifaEntityNotFoundException,
                                           ValidationException

Reverts merge operation. Returns the secondary organisation when unmerge operations is completed.

Parameters:

primaryOrganisationFifaId - Primary organisation FIFA Unique Identifier

secondaryOrganisationFifaId - Secondary organisation FIFA Unique Identifier

Throws:

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

InvalidClientDataException

FifaEntityNotFoundException

FifaConflictException

ValidationException

TooManyRequestsException

updateOrganisation

OrganisationLocalType updateOrganisation(OrganisationLocalType organisation,
                                         Boolean force)
                                  throws FifaConnectIdException,
                                         com.fifa.connectservicebus.sdk.AuthenticationException,
                                         UnauthorizedException,
                                         InvalidClientDataException,
                                         FifaEntityNotFoundException,
                                         FifaDuplicatedOrganisationFoundException,
                                         ValidationException

Updates the organisation.

Parameters:

organisation - Object containing information about the organisation to update

force - - force update organisation

Throws:

FifaConnectIdException

InvalidClientDataException

FifaEntityNotFoundException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

FifaDuplicatedOrganisationFoundException

ValidationException

TooManyRequestsException

updateOrganisation

OrganisationLocalType updateOrganisation(OrganisationLocalType organisation)
                                  throws FifaConnectIdException,
                                         com.fifa.connectservicebus.sdk.AuthenticationException,
                                         UnauthorizedException,
                                         InvalidClientDataException,
                                         FifaEntityNotFoundException,
                                         FifaDuplicatedOrganisationFoundException,
                                         ValidationException

Updates the organisation.

Parameters:

organisation - Object containing information about the organisation to update

Throws:

FifaConnectIdException

InvalidClientDataException

FifaEntityNotFoundException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

FifaDuplicatedOrganisationFoundException

ValidationException

TooManyRequestsException

getFacility

FacilityLocalType getFacility(String facilityFifaId)
                       throws FifaConnectIdException,
                              com.fifa.connectservicebus.sdk.AuthenticationException,
                              UnauthorizedException,
                              InvalidClientDataException,
                              FifaEntityNotFoundException,
                              ValidationException

Gets facility data associated with the specified FIFA Unique Identifier.

Parameters:

facilityFifaId - FIFA Unique Identifier.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

registerFacility

String registerFacility(FacilityLocalType facility,
                        Boolean force)
                 throws FifaConnectIdException,
                        com.fifa.connectservicebus.sdk.AuthenticationException,
                        FifaDuplicatedFacilityFoundException,
                        UnauthorizedException,
                        InvalidClientDataException,
                        ValidationException

Registers a new facility and assigns FIFA Unique Identifier. Uses facility data as defined in FIFA Data Standard.

Parameters:

facility - - object containing information about the facility.

force - - force register facility

Throws:

InvalidClientDataException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

FifaDuplicatedFacilityFoundException

ValidationException

TooManyRequestsException

registerFacility

String registerFacility(FacilityLocalType facility)
                 throws FifaConnectIdException,
                        com.fifa.connectservicebus.sdk.AuthenticationException,
                        FifaDuplicatedFacilityFoundException,
                        UnauthorizedException,
                        InvalidClientDataException,
                        ValidationException

Registers a new facility and assigns FIFA Unique Identifier. Uses facility data as defined in FIFA Data Standard.

Parameters:

facility - - object containing information about the facility.

Throws:

InvalidClientDataException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

FifaDuplicatedFacilityFoundException

ValidationException

TooManyRequestsException

updateFacility

FacilityLocalType updateFacility(FacilityLocalType facility,
                                 Boolean force)
                          throws FifaConnectIdException,
                                 com.fifa.connectservicebus.sdk.AuthenticationException,
                                 UnauthorizedException,
                                 InvalidClientDataException,
                                 FifaEntityNotFoundException,
                                 FifaDuplicatedFacilityFoundException,
                                 ValidationException

Updates the facility.

Parameters:

facility - Object containing information about the facility.

force - - force update facility

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

FifaDuplicatedFacilityFoundException

ValidationException

TooManyRequestsException

updateFacility

FacilityLocalType updateFacility(FacilityLocalType facility)
                          throws FifaConnectIdException,
                                 com.fifa.connectservicebus.sdk.AuthenticationException,
                                 UnauthorizedException,
                                 InvalidClientDataException,
                                 FifaEntityNotFoundException,
                                 FifaDuplicatedFacilityFoundException,
                                 ValidationException

Updates the facility.

Parameters:

facility - Object containing information about the facility.

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

FifaDuplicatedFacilityFoundException

ValidationException

TooManyRequestsException

findOrganisations

FindOrganisationsResponseType findOrganisations(FindOrganisationsRequestType request)
                                         throws FifaConnectIdException,
                                                IOException,
                                                com.fifa.connectservicebus.sdk.AuthenticationException,
                                                ValidationException

Searches for organisations.

Parameters:

request - - >Object containing search criteria

Returns:

FindOrganisationsResponseType - Object containing a list of found organisations

Throws:

FifaConnectIdException

IOException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

TooManyRequestsException

findFacilities

FindFacilitiesResponseType findFacilities(FindFacilitiesRequestType request)
                                   throws FifaConnectIdException,
                                          IOException,
                                          com.fifa.connectservicebus.sdk.AuthenticationException,
                                          ValidationException

Searches for facilities.

Parameters:

request - - Object containing search criteria

Returns:

FindFacilitiesResponseType - Object containing a list of found facilities

Throws:

FifaConnectIdException

IOException

com.fifa.connectservicebus.sdk.AuthenticationException

ValidationException

TooManyRequestsException

getAllNationalAssociationsOnboardedStatus

NationalAssociationsOnboardedResponseType getAllNationalAssociationsOnboardedStatus()
                                                                             throws IOException,
                                                                                    UnauthorizedException,
                                                                                    FifaEntityNotFoundException,
                                                                                    IOException,
                                                                                    com.fifa.connectservicebus.sdk.AuthenticationException,
                                                                                    InvalidClientDataException,
                                                                                    FifaConnectIdException

Asks Connect ID if specific organisation is onboarded.

Returns:

NationalAssociationsOnboardedResponseType - Object containing list of all national associations fifa identifiers and corresponding onboarded statuses.

Throws:

UnauthorizedException

com.fifa.connectservicebus.sdk.AuthenticationException

FifaConnectIdException

TooManyRequestsException

IOException

FifaEntityNotFoundException

InvalidClientDataException

getNationalAssociationsOnboardedStatus

NationalAssociationsOnboardedResponseType getNationalAssociationsOnboardedStatus(NationalAssociationsOnboardedRequestType request)
                                                                          throws IOException,
                                                                                 UnauthorizedException,
                                                                                 FifaEntityNotFoundException,
                                                                                 com.fifa.connectservicebus.sdk.AuthenticationException,
                                                                                 FifaConnectIdException,
                                                                                 ValidationException

Asks Connect ID if specific organisation is onboarded.

Parameters:

request - - Object containing list of national association identifiers

Returns:

NationalAssociationsOnboardedResponseType - Object containing list of national associations fifa identifiers and corresponding onboarded statuses.

Throws:

UnauthorizedException

FifaEntityNotFoundException

InvalidClientDataException

com.fifa.connectservicebus.sdk.AuthenticationException

FifaConnectIdException

ValidationException

TooManyRequestsException

IOException

getMemberAssociationForFifaId

MemberAssociationResponseType getMemberAssociationForFifaId(String organisationFifaId)
                                                     throws InvalidClientDataException,
                                                            FifaEntityNotFoundException,
                                                            FifaConnectIdException,
                                                            com.fifa.connectservicebus.sdk.AuthenticationException,
                                                            UnauthorizedException,
                                                            ValidationException

Gets FIFA Id and short name of the Member Association the searched organisation belongs to.

Parameters:

organisationFifaId -

Returns:

MemberAssociationResponseType

Throws:

InvalidClientDataException

FifaEntityNotFoundException

FifaConnectIdException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

ValidationException

TooManyRequestsException

registerAsDataHolderOfPerson

void registerAsDataHolderOfPerson(String personFifaId)
                           throws ValidationException,
                                  com.fifa.connectservicebus.sdk.AuthenticationException,
                                  UnauthorizedException,
                                  InvalidClientDataException,
                                  FifaPersonMergedException,
                                  FifaEntityNotFoundException,
                                  FifaEntityDeletedException,
                                  FifaConnectIdException

Registers current system as Data Holder for the given person

Parameters:

personFifaId - Person FIFA Unique Identifier

Throws:

ValidationException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

InvalidClientDataException

FifaPersonMergedException

FifaEntityNotFoundException

FifaEntityDeletedException

FifaConnectIdException

getDataHoldersOfPerson

List<String> getDataHoldersOfPerson(String personFifaId)
                             throws ValidationException,
                                    com.fifa.connectservicebus.sdk.AuthenticationException,
                                    UnauthorizedException,
                                    InvalidClientDataException,
                                    FifaPersonMergedException,
                                    FifaEntityNotFoundException,
                                    FifaEntityDeletedException,
                                    FifaConnectIdException

Gets systems registered as Data Holder for the given person

Parameters:

personFifaId - Person FIFA Unique Identifier

Returns:

List of data holders

Throws:

ValidationException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

InvalidClientDataException

FifaPersonMergedException

FifaEntityNotFoundException

FifaEntityDeletedException

FifaConnectIdException

getMergedSecondaryFifaIdsForPerson

List<String> getMergedSecondaryFifaIdsForPerson(String personFifaId)
                                         throws ValidationException,
                                                com.fifa.connectservicebus.sdk.AuthenticationException,
                                                UnauthorizedException,
                                                InvalidClientDataException,
                                                FifaEntityNotFoundException,
                                                FifaConnectIdException

Gets secondary FIFA IDs directly merged into person

Parameters:

personFifaId - Person FIFA Unique Identifier

Returns:

List of merged secondary FIFA IDs

Throws:

ValidationException

com.fifa.connectservicebus.sdk.AuthenticationException

UnauthorizedException

InvalidClientDataException

FifaEntityNotFoundException

FifaEntityDeletedException

FifaConnectIdException

getHashingClient

HashingServiceClient getHashingClient()

Returns current instance of HashingClient

getIdDirectoryClient

IdDirectoryServiceClient getIdDirectoryClient()

Returns current instance of IdDirectoryClient