Package ch.tocco.nice2.optional.address.impl.action.uidsearch.soap

Interface IPublicServices

public interface IPublicServices

This class was generated by Apache CXF 4.1.1 2025-03-13T13:52:36.930+01:00 Generated source version: 4.1.1

Method Summary

Modifier and Type	Method	Description
ArrayOfOrganisationType	getByUID(UidStructureType uid)	Get the core data (Kernmerkmale) of a UID entity by its UID UID of requested UID entity The requested UID entity
OrganisationType	getOrganisationSample()	Returns a data sample to demonstrate the structure of eCH-0108:organisationType.
UidEntitySearchResponse	search(UidEntityPublicSearchRequest searchParameters, SearchConfiguration config)	Search for UID-Einheiten Search parameters formated as eCH-0108-3-0f document Configuration parameters to customize search behaviour XML-Document of type uid-wse
boolean	validateUID(String uid)	Validate a UID UID to validate.
boolean	validateVatNumber(String vatNumber)	Validate a VatNumber VAT number to validate true if exists

Method Details

getOrganisationSample

@Action(input="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/GetOrganisationSample",output="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/GetOrganisationSampleResponse",fault={@FaultAction(className=IPublicServicesGetOrganisationSampleBusinessFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/GetOrganisationSamplebusinessFaultFault"),@FaultAction(className=IPublicServicesGetOrganisationSampleInfrastructureFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/GetOrganisationSampleinfrastructureFaultFault"),@FaultAction(className=IPublicServicesGetOrganisationSampleSecurityFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/GetOrganisationSamplesecurityFaultFault")})
@RequestWrapper(localName="GetOrganisationSample",
                targetNamespace="http://www.uid.admin.ch/xmlns/uid-wse",
                className="ch.tocco.nice2.optional.address.impl.action.uidsearch.soap.GetOrganisationSample")
@ResponseWrapper(localName="GetOrganisationSampleResponse",
                 targetNamespace="http://www.uid.admin.ch/xmlns/uid-wse",
                 className="ch.tocco.nice2.optional.address.impl.action.uidsearch.soap.GetOrganisationSampleResponse")
OrganisationType getOrganisationSample()
                                throws IPublicServicesGetOrganisationSampleBusinessFaultFaultFaultMessage,
IPublicServicesGetOrganisationSampleInfrastructureFaultFaultFaultMessage,
IPublicServicesGetOrganisationSampleSecurityFaultFaultFaultMessage

Returns a data sample to demonstrate the structure of eCH-0108:organisationType. The sample contains all mapped fields. All data is fictional.

Data sample

Throws:

IPublicServicesGetOrganisationSampleBusinessFaultFaultFaultMessage

IPublicServicesGetOrganisationSampleInfrastructureFaultFaultFaultMessage

IPublicServicesGetOrganisationSampleSecurityFaultFaultFaultMessage

validateVatNumber

@Action(input="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/ValidateVatNumber",output="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/ValidateVatNumberResponse",fault={@FaultAction(className=IPublicServicesValidateVatNumberBusinessFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/ValidateVatNumberbusinessFaultFault"),@FaultAction(className=IPublicServicesValidateVatNumberInfrastructureFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/ValidateVatNumberinfrastructureFaultFault"),@FaultAction(className=IPublicServicesValidateVatNumberSecurityFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/ValidateVatNumbersecurityFaultFault")})
@RequestWrapper(localName="ValidateVatNumber",
                targetNamespace="http://www.uid.admin.ch/xmlns/uid-wse",
                className="ch.tocco.nice2.optional.address.impl.action.uidsearch.soap.ValidateVatNumber")
@ResponseWrapper(localName="ValidateVatNumberResponse",
                 targetNamespace="http://www.uid.admin.ch/xmlns/uid-wse",
                 className="ch.tocco.nice2.optional.address.impl.action.uidsearch.soap.ValidateVatNumberResponse")
boolean validateVatNumber(String vatNumber)
                   throws IPublicServicesValidateVatNumberBusinessFaultFaultFaultMessage,
IPublicServicesValidateVatNumberInfrastructureFaultFaultFaultMessage,
IPublicServicesValidateVatNumberSecurityFaultFaultFaultMessage

Validate a VatNumber

VAT number to validate true if exists

Throws:

IPublicServicesValidateVatNumberBusinessFaultFaultFaultMessage

IPublicServicesValidateVatNumberInfrastructureFaultFaultFaultMessage

IPublicServicesValidateVatNumberSecurityFaultFaultFaultMessage

validateUID

@Action(input="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/ValidateUID",output="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/ValidateUIDResponse",fault={@FaultAction(className=IPublicServicesValidateUIDBusinessFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/ValidateUIDbusinessFaultFault"),@FaultAction(className=IPublicServicesValidateUIDInfrastructureFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/ValidateUIDinfrastructureFaultFault"),@FaultAction(className=IPublicServicesValidateUIDSecurityFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/ValidateUIDsecurityFaultFault")})
@RequestWrapper(localName="ValidateUID",
                targetNamespace="http://www.uid.admin.ch/xmlns/uid-wse",
                className="ch.tocco.nice2.optional.address.impl.action.uidsearch.soap.ValidateUID")
@ResponseWrapper(localName="ValidateUIDResponse",
                 targetNamespace="http://www.uid.admin.ch/xmlns/uid-wse",
                 className="ch.tocco.nice2.optional.address.impl.action.uidsearch.soap.ValidateUIDResponse")
boolean validateUID(String uid)
             throws IPublicServicesValidateUIDBusinessFaultFaultFaultMessage,
IPublicServicesValidateUIDInfrastructureFaultFaultFaultMessage,
IPublicServicesValidateUIDSecurityFaultFaultFaultMessage

Validate a UID

UID to validate. Accepted format: 'CHE123456789' or 'CHE-123.456.789' true if the UID exists in the UID register

Throws:

IPublicServicesValidateUIDBusinessFaultFaultFaultMessage

IPublicServicesValidateUIDInfrastructureFaultFaultFaultMessage

IPublicServicesValidateUIDSecurityFaultFaultFaultMessage

getByUID

@Action(input="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/GetByUID",output="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/GetByUIDResponse",fault={@FaultAction(className=IPublicServicesGetByUIDBusinessFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/GetByUIDbusinessFaultFault"),@FaultAction(className=IPublicServicesGetByUIDInfrastructureFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/GetByUIDinfrastructureFaultFault"),@FaultAction(className=IPublicServicesGetByUIDSecurityFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/GetByUIDsecurityFaultFault")})
@RequestWrapper(localName="GetByUID",
                targetNamespace="http://www.uid.admin.ch/xmlns/uid-wse",
                className="ch.tocco.nice2.optional.address.impl.action.uidsearch.soap.GetByUID")
@ResponseWrapper(localName="GetByUIDResponse",
                 targetNamespace="http://www.uid.admin.ch/xmlns/uid-wse",
                 className="ch.tocco.nice2.optional.address.impl.action.uidsearch.soap.GetByUIDResponse")
ArrayOfOrganisationType getByUID(UidStructureType uid)
                          throws IPublicServicesGetByUIDBusinessFaultFaultFaultMessage,
IPublicServicesGetByUIDInfrastructureFaultFaultFaultMessage,
IPublicServicesGetByUIDSecurityFaultFaultFaultMessage

Get the core data (Kernmerkmale) of a UID entity by its UID

UID of requested UID entity The requested UID entity

Throws:

IPublicServicesGetByUIDBusinessFaultFaultFaultMessage

IPublicServicesGetByUIDInfrastructureFaultFaultFaultMessage

IPublicServicesGetByUIDSecurityFaultFaultFaultMessage

search

@Action(input="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/Search",output="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/SearchResponse",fault={@FaultAction(className=IPublicServicesSearchBusinessFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/SearchbusinessFaultFault"),@FaultAction(className=IPublicServicesSearchInfrastructureFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/SearchinfrastructureFaultFault"),@FaultAction(className=IPublicServicesSearchSecurityFaultFaultFaultMessage.class,value="http://www.uid.admin.ch/xmlns/uid-wse/IPublicServices/SearchsecurityFaultFault")})
@RequestWrapper(localName="Search",
                targetNamespace="http://www.uid.admin.ch/xmlns/uid-wse",
                className="ch.tocco.nice2.optional.address.impl.action.uidsearch.soap.Search")
@ResponseWrapper(localName="SearchResponse",
                 targetNamespace="http://www.uid.admin.ch/xmlns/uid-wse",
                 className="ch.tocco.nice2.optional.address.impl.action.uidsearch.soap.SearchResponse")
UidEntitySearchResponse search(UidEntityPublicSearchRequest searchParameters,
 SearchConfiguration config)
                        throws IPublicServicesSearchBusinessFaultFaultFaultMessage,
IPublicServicesSearchInfrastructureFaultFaultFaultMessage,
IPublicServicesSearchSecurityFaultFaultFaultMessage

Search for UID-Einheiten

Search parameters formated as eCH-0108-3-0f document Configuration parameters to customize search behaviour XML-Document of type uid-wse

Throws:

IPublicServicesSearchBusinessFaultFaultFaultMessage

IPublicServicesSearchInfrastructureFaultFaultFaultMessage

IPublicServicesSearchSecurityFaultFaultFaultMessage