Service: ContactInformationPublicService

Version: 2_21 (other versions, change log, ZUMSTEIN_V3.12-SNAPSHOT) Latest frozen version. Base by default all your developments on this one.

SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnco/external-remoting/com.secutix.service.contact.v2_21.ContactInformationPublicService.webservice?wsdl

REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnco/backend-apis/contactInformationPublicService/v2_21/{methodName} Replace {methodName} for the desired method name as shown below.

To get the endpoint for your own institution, replace "myinstit" (just after https://) in the url by your own institution code.

For further documentation and examples, please check in Platform Website.

Methods:

createCulturalContact:
deleteAccount:
deleteStructureMember: This method remove a contact member of a structure.
fastContactSearch:
formatContactAddresses: Same as save contact address except it does not persist data.
getAdvantages:
getAvailableAdministrativeNumbers: This method return all known administrative numbers.
getAvailableAuthorizations: This method returns the list of all available authorizations.
getAvailableContactCriteria: This method returns the list of available contact criteria.
getAvailableContactIndicators: This method return all known administrative numbers.
getAvailableLocalityCriterionElements: This method returns all the available locality criterion elements.
getContactData: This method returns the data entered at the creation or modification of a contact, except for the password.
getContactsData: This method returns the data entered at the creation or modification of a contact, except for the password.
getScreenLayout: This method list all the screen fields for the passed screen names stored in {@link ScreenConfiguration}
getStructureAdministrativeNumbers: This method returns the list of administrative numbers for the given structure and administrative number codes.
getStructureTypes: This method returns the list of all known structure types.
listStructureMembersByCriteria: This method lists all the contact matching the give search criterion
saveIndividualContactData: This method allows to create or update a contact of type individual.
saveStructureAdministrativeNumbers: This method saves the list of administrative numbers for the given structure.
saveStructureContactData: This method allows to modify or create a contact of the type structure.
saveStructureContacts: This method create/update a list of structure contacts.
saveStructureMember: This method allows to modify or create a contact member of a structure.
saveStructureMembers: This method create/update a list of structure members.
searchByFileHistory: This method return information of contacts that are linked to files owned by given contact
searchContactByCriteria: Allow to search for contacts passing a choice of filters : contact reference, roles, connections, email, phone, etc.
unsubscribeContact:

createCulturalContact

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

contactDataList

List of CulturalContactData

CulturalContactData

contactNumber	String (20)
createLogin	boolean
email	String
firstName	String
identifier	Long
lastName	String
requestId	Integer
statusCode	String (8)
statusDetail	String

Return value

CulturalContactCreationResult

culturalContactData	List of ContactDataResult
identifierContactMap	Map of Long, String
requestId	Integer
statusCode	String (8)
statusDetail	String

ContactDataResult

addresses	List of ContactAddressData
advantages	List of ContactAdvantageData
authorizations	List of AuthorizationData
contactConnections	List of ContactConnectionDetailed
contactCriteria	List of ExternalContactCriterionData
contactFileHistoryCriteria	ContactFileHistoryCriteria	Returns if current contact is a purchaser or biller with the owner of the given file contact number in the request param to searchContact call
contactId	Long
contactNumber	String (20)
contactOrigin	ContactOriginData
contactQualities	List of ContactQuality
creationDate	Date
endValidityDate	Date
financialData	FinancialData
function	String
hasAdvantages	boolean
hasWarning	boolean
indicators	List of IndicatorData
individualContact	IndividualContactData
individualPhotoData	IndividualPhotoData
invalidatedContactQualities	List of ContactQuality
isGuest	boolean
login	String
loginLastUpdateTime	Date
loginLastUpdateUser	String
mergedContactNumber	String (20)
role	(MEMBER\|PARTNER\|PRODUCER\| PUBLIC\|RELAY\|SUPPLIER\| GUIDE\|CONTRACTOR\|SUPPORT\| EXHIBITOR\|ARTIST)
socialConnections	List of ContactSocialConnection
state	(VALID\|INVALIDATED\| PENDING\|REJECTED\| DUPLICATE)
structureContact	StructureContactData
type	(INDIVIDUAL\|STRUCTURE)
requestId	Integer
statusCode	String (8)
statusDetail	String

ContactAddressData

billingAddress	boolean
contactAddressId	Long
countryCode	String (8)
documentFormattedAddress	String
faxNumber	String	Fax number. E164 format. +41214232222
formattedAddress	String
gpsLatitude	String
gpsLongitude	String
line1	String
line2	String
line3	String
localityCriteriaElements	List of LocalityCriterionElement	Optional
main	boolean
name	String
normalizationRating	(UNKNOWN\|COUNTRY\|ZIPCODE\| TOWN\|WAY\|WAYNUMBER)
normalizationState	(NORMALIZED\| TO_BE_NORMALIZED\| NOT_TO_BE_NORMALIZED\| NOT_NORMALIZED)
phoneNumber1	String	Phone number. E164 format. +41214232222
phoneNumber2	String	Phone number. E164 format. +41214232222
phoneNumber3	String	Phone number. E164 format. +41214232222
shippingAddress	boolean
town	String
zipCode	String (8)

LocalityCriterionElement

countryCode	String (8)	Optional: Countrycode in ISO Alpha-2 format. It should match with contactAddressData.countryCode
localityCriterionCode	String (8)	Mandatory: Represents code of locality criterion code
localityCriterionElementCode	String (8)	Mandatory: Represents code of locality criterion element
localityCriterionElementName	String	Optional: Represents the name of locality criterion element
localityCriterionName	MultiLingual

MultiLingual

translations	List of Translation

Translation

locale	String (2)
value	String

ContactAdvantageData

advantageId	Long
advantageType	(PUBLIC\|CODE\|CONTACT)
availability	Long
availabilityLevel	(GOOD\|LIMITED\|NONE)
fileId	Long
orderData	List of OrderData
orderDate	Date

OrderData

fileId	long
orderDate	Date

AuthorizationData

allowed	boolean
authorizationCode	String (8)

ContactConnectionDetailed

chidStructureContactData	StructureContactData
childIndividualContactData	IndividualContactData
parentIndividualContactData	IndividualContactData
parentStructureContactData	StructureContactData
contactConnectionId	Long
contactNumber	String (20)
isParentContact	boolean
type	(DISTRIBUTION_PARTNER\| MEMBER\|STRUCT_MEMBER\| FAMILY\|SPONSOR\| SHIPMENT_CONTACT\| SUBGROUP_MEMBER\| INVOICE_CONTACT\| INVOICE_ENTITY\|ATR)

StructureContactData

addressSalutation	String
allContactNumbers	List of String
alternativeEmails	Set of String
badgeIdentifier	String	Badge identifier. Optional field
cellPhoneNumber	String	Cell phone number, internationalized. E164 format. +41797894554
community	boolean
confidentialityLevelEnum	(FREE\|RESTRICTED\| CONFIDENTIAL)
contactNumber	String (20)
email	String
faxNumber	String	Fax number. E164 format. +41214232222
letterSalutation	String
login	String
numberOfEmployees	Integer
parentStructureContactNumber	String (20)
password	String
phoneNumber1	String	Phone number. E164 format. +41214232222
phoneNumber2	String	Phone number. E164 format. +41214232222
phoneNumber3	String	Phone number. E164 format. +41214232222
primaryContactId	Long
prospect	boolean
remark	String
role	(PUBLIC\|PARTNER\|PRODUCER\| SUPPLIER\|CONTRACTOR\| EXHIBITOR)	Optional. Structure role. If not defined, set to PUBLIC.
siretCode	String (8)
state	(VALID\|INVALIDATED\| PENDING\|REJECTED\| DUPLICATE)
structureAddressName1	String	Mandatory while creating a new structure
structureAddressName2	String
structureCommunityType	String
structureEuropeanVatCode	String (8)
structureOfficialName	String	Mandatory while creating a new structure
structurePreferredLanguage	String	Mandatory while creating a new structure
structureTypeId	Long

IndividualContactData

addressSalutation	String
alternativeEmails	Set of String
badgeIdentifier	String
cellPhoneNumber	String	Cell phone number, internationalized. E164 format. +41797894554
cellPhoneNumberVerified	boolean
confidentialityLevelEnum	(FREE\|RESTRICTED\| CONFIDENTIAL)
contactNumber	String (20)
countryCode	String (8)
digestedPassword	String
email	String
encryptedPassword	String
endValidityDate	Date
endValidityReason	String
faxNumber	String	Fax number. E164 format. +41214232222
handicapType	String
individualBirthdate	Date
individualCountryCode	String (8)
individualFirstname	String
individualFirstnamePhonetic	String
individualGender	(FEMALE\|MALE\|UNKNOWN)
individualIdNumber	String
individualLastname	String
individualLastnamePhonetic	String
individualPreferredLanguage	String	Mandatory parameter while creating new individuals
individualTitle	String	Possible values : MR, MRS, MR_AND_MRS, MISS et UNDEFINED Mandatory parameter while creating new individuals
isActive	boolean
isGuest	boolean
letterSalutation	String
login	String
loginCreation	(FORCE_LOGIN_CREATION\| REUSE_CONTACT_IF_LOGIN_EXISTS\|DO_NOT_CREATE_LOGIN)
nickname	String
password	String
phoneNumber1	String	Phone number. E164 format. +41214232222
phoneNumber2	String	Phone number. E164 format. +41214232222
phoneNumber3	String	Phone number. E164 format. +41214232222
prospect	boolean
remark	String
role	(PUBLIC\|RELAY\|GUIDE\| SUPPORT)	Optional. Contact role. If not defined, set to PUBLIC.
zipCode	String (8)
requestId	Integer
statusCode	String (8)
statusDetail	String

ExternalContactCriterionData
DTO for ContactCriterionData used by external world. Version 2.2
criterionIdCode	String (8)
values	List of String

ContactFileHistoryCriteria

biller	Boolean	Check for contacts result who are billing contacts of a file owned by fileOwnerContactNumber
fileOwnerContactNumber	String (20)	File contact of type OWNER
purchaser	Boolean	Check for contacts result who are purchasers of a file owned by fileOwnerContactNumber
shippingContact	Boolean	Search for contacts who are shipping contacts of a file owned by fileOwnerContactNumber

ContactOriginData

code	String (8)
translations	Map of StringString

ContactQuality

audienceCategories	List of AudienceCategoryPriceLevel
seasonId	Long
seasonName	String

AudienceCategoryPriceLevel

audienceCatId	Long
audienceSubCategory	AudienceSubCategory
instanceNumber	String
mainCategory	(OCCASIONAL\|SUBSCRIBER\| MEMBER\|INVITED\| INSIDE_SEASONTICKET)
movementEndDate	Date	Movement end date, it's set in case of membership to store the membership end validity
movementId	Long
movementStartDate	Date	Movement start date, it's set in case of membership to store the membership start validity
partnerOrganizationName	String
priceLevelCode	String (8)
priceLevelId	Long
product	String
productId	Long
secondaryCategory	(INDIVIDUAL\|COMMUNITY\| GROUP\|TAXED\|FREE\| PROMOTIONAL)

AudienceSubCategory

audienceCategoryKind	(FULL\|REDUCED\|FREE)
code	String (8)
externalName	String
id	Long
internalName	String

FinancialData

agreementReference	String
agreementSigningDate	Date
bic	String
creditNoteBalance	Long
iban	String
maxWaitingAccountBalance	Long
waitingAccountAllowed	boolean
waitingAccountBalance	Long

IndicatorData

indicatorIdCode	String (8)
internalName	MultiLingual
level	String
value	String

IndividualPhotoData
Contains an individual's photo. Supported formats are jpg, png and gif.
fileContent	byte	Content of file. Max size : 200000 bytes. Passing empty or null here removes the file.
fileName	String	Name of the image file containing the photo. Passing empty or null here removes the photo.
mimeType	(JPG\|PNG\|GIF)

ContactSocialConnection

identityProvider	(NONE\|FACEBOOK\|GOOGLE\| TWITTER\|UEFA\|MDP\| SWISSPASS\|ACCOUNT_KIT\| GIGYA\|OIDC)
providerUserReference	String

deleteAccount

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

contactNumber	String (20)
deleteStrict	boolean	Mandatory

Return value

ContactDeleteResult

contactInfo	List of String
isContactDeletetable	boolean
expectedException	boolean
statusMessage	String
requestId	Integer
statusCode	String (8)
statusDetail	String

deleteStructureMember

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method remove a contact member of a structure.

Parameters

contactNumber	String (20)	Mandatory Mandatory, the number to identify the contact
structureContactNumber	String (20)

Return value

WebMethodResult2

requestId	Integer
statusCode	String (8)
statusDetail	String

fastContactSearch

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

requestId	Integer
contactNumberOrName	String
contactRoleList	List of (MEMBER\|PARTNER\|PRODUCER\| PUBLIC\|RELAY\|SUPPLIER\| GUIDE\|CONTRACTOR\|SUPPORT\| EXHIBITOR\|ARTIST)
contactTypeList	List of (INDIVIDUAL\|STRUCTURE)
maxResults	Long

Return value

FastContactSearchResult

contacts	List of ContactDataResult
requestId	Integer
statusCode	String (8)
statusDetail	String

formatContactAddresses

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Same as save contact address except it does not persist data. ContactAddressResult contains passed address augmented with its formatted version

Parameters

contactNumber	String (20)
addresses	List of ContactAddressData

Return value

ContactAddressesResult

contactAddressesData	ContactAddressesData
requestId	Integer
statusCode	String (8)
statusDetail	String

ContactAddressesData

addressesData	List of ContactAddressData

getAdvantages

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

contactNumber	String (20)
advantageType	(PUBLIC\|CODE\|CONTACT)

Return value

ContactAdvantageResult

contactAdvantagesData	ContactAdvantagesData
requestId	Integer
statusCode	String (8)
statusDetail	String

ContactAdvantagesData

advantagesData	List of ContactAdvantageData

getAvailableAdministrativeNumbers

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method return all known administrative numbers.

Parameters

Return value

AvailableAdministrativeNumbersResult

externalAdministrativeNumberDefinitionData	List of ExternalAdministrativeNumberDefinitionData
requestId	Integer
statusCode	String (8)
statusDetail	String

ExternalAdministrativeNumberDefinitionData

adminNumCode	String (8)
adminNumIdCode	String (8)
externalName	MultiLingual
rank	Integer

getAvailableAuthorizations

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method returns the list of all available authorizations.

Parameters

Return value

AvailableAuthorizationsResult

authorizationDefinitionData	List of AuthorizationDefinitionData
requestId	Integer
statusCode	String (8)
statusDetail	String

AuthorizationDefinitionData

authorizationCode	String (8)
dataType	(CHECKBOX\|RADIO)
externalName	MultiLingual
mandatory	Boolean
rank	Integer
visibility	(READ\|UPDATE\|NONE)

getAvailableContactCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method returns the list of available contact criteria. This list depends on the organization and changes infrequently, so it is requested that the result of this method should be cached in the caller side for at least 30 minutes.

Parameters

Return value

ExternalContactCriterionResult

contactCriterionDefinitionDatas	List of ExternalContactCriterionDefinitionData
requestId	Integer
statusCode	String (8)
statusDetail	String

ExternalContactCriterionDefinitionData

criterionCode	String (8)
criterionIdCode	String (8)
criterionType	(SIMPLE\|LIST)
dataType	(TEXTINPUT\|CITYINPUT\| CHECKBOX\|RADIO\|COLOR\| DATEINPUT\|TIME\|DECIMAL\| INTEGER\|LONG\|PERCENT\| MONEY\|PHONE_NUMBER\| TEXTAREA\|IBAN\|URL\| DROPDOWN\|DRAGNDROPLIST)
elements	List of ContactCriterionElementDefinition
externalName	MultiLingual
mandatory	Boolean
rank	Integer
screenVisibilityType	(CONTACT_CRITERION\| AUTOMATIC_CUP_SCHEME\| MANAGEMENT_FINANCIAL)
target	(INDIVIDUAL\|STRUCTURE\| BOTH)
visibility	(READ\|UPDATE)

ContactCriterionElementDefinition

code	String (8)
idCode	String (8)
rank	Integer
value	MultiLingual

getAvailableContactIndicators

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method return all known administrative numbers.

Parameters

Return value

AvailableContactIndicatorResult

contactIndicatorDefinitionDatas	List of ContactIndicatorDefinitionData
requestId	Integer
statusCode	String (8)
statusDetail	String

ContactIndicatorDefinitionData

externalName	MultiLingual
indicatorCode	String (8)
indicatorValueDataType	(BOOLEAN\|NUMERIC\|STRING\| DATE)
rank	Integer

getAvailableLocalityCriterionElements

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method returns all the available locality criterion elements.

Parameters

countryCodes

List of String

Optional, list of country codes in ISO-Alpha-2 format. The result is filtered by country codes if provided.

Return value

LocalityCriterionElementListResult
Created by asi on 08.08.2017.
elements	List of LocalityCriterionElement
requestId	Integer
statusCode	String (8)
statusDetail	String

getContactData

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method returns the data entered at the creation or modification of a contact, except for the password. The data also includes a particular nickname for the contact. EITHER

Parameters

contactNumber	String (20)	The contact number associated with the contact data. Provide this one of the hash.
contactHash	String	The hash value associated with the contact data. Provide this one of the contact number
details	List of (GENERAL\|QUALITIES\| AUTHORIZATIONS\|CRITERIA\| INDICATORS\|ADVANTAGES\| ADDRESSES\|COM_MEANS\| FINANCIAL\|CONNECTIONS\| INDIVIDUAL_PHOTO\| INVALIDATED_QUALITIES)	A list of ContactDetailsEnum specifying additional details to include in the contact data. Possible values for the details parameter include: GENERAL: General contact information about the individual and or the structure (first name, last name, dob...). QUALITIES: Qualities associated with the contact (member, season ticket holder). AUTHORIZATIONS: Authorizations of the contact -> opt-ins. CRITERIA: Specific criteria related to the contac. INDICATORS: Computed Indicators associated with the contact. ADVANTAGES: Advantages of the contact that are currently valid. ADVANTAGES_FUTURE: Advantages of the contact related to a future date. ADDRESSES: Addresses associated with the contact. COM_MEANS: Deprecated.. FINANCIAL: Financial information related to the contact (waiting account amount...). CONNECTIONS: Connections of the contact with other contacts. INDIVIDUAL_PHOTO: Individual photo of the contact. INVALIDATED_QUALITIES: Invalidated qualities of the contact.

Return value

ContactDataResult

getContactsData

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method returns the data entered at the creation or modification of a contact, except for the password. The data also includes a particular nickname for the given list of contact.

Parameters

contactNumber	List of String	Mandatory Mandatory, the number used to identify the contact
details	List of (GENERAL\|QUALITIES\| AUTHORIZATIONS\|CRITERIA\| INDICATORS\|ADVANTAGES\| ADDRESSES\|COM_MEANS\| FINANCIAL\|CONNECTIONS\| INDIVIDUAL_PHOTO\| INVALIDATED_QUALITIES)

Return value

ContactsDataResult

contactsData	List of ContactDataResult
requestId	Integer
statusCode	String (8)
statusDetail	String

getScreenLayout

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method list all the screen fields for the passed screen names stored in {@link ScreenConfiguration}

Parameters

screenNames

List of String

Mandatory
Mandatory, list of names of screens for which the layout is required

Return value

ScreenResult

screenDefinition	List of ScreenDefinition
requestId	Integer
statusCode	String (8)
statusDetail	String

ScreenDefinition

screenFields	List of ScreenFieldDefinition
screenName	String

ScreenFieldDefinition

fieldGroup	String
rank	Integer
screenField	String
screenPart	String
value	(TRUE\|FALSE\| MANDATORY_BY_GROUP\| MANDATORY\|OPTIONAL\| MANDATORY_NOEDIT\| MANDATORY_BY_GROUP_NOEDIT\| TRUE_UNCHECK\|TRUE_CHECK)

getStructureAdministrativeNumbers

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method returns the list of administrative numbers for the given structure and administrative number codes.

Parameters

structureContactNumber	String (20)
adminNumIdCodes	List of String

Return value

StructureAdministrativeNumbersResult

externalAdministrativeNumberData	List of ExternalAdministrativeNumberData
requestId	Integer
statusCode	String (8)
statusDetail	String

ExternalAdministrativeNumberData

adminNumIdCode	String (8)
value	String

getStructureTypes

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method returns the list of all known structure types. This list changes infrequently, so it is requested that the result of this method should be cached in the caller side for at least 1 day.

Parameters

Return value

StructureTypesResult

structureTypeData	List of StructureTypeData
requestId	Integer
statusCode	String (8)
statusDetail	String

StructureTypeData

code	String (8)
externalName	MultiLingual
id	Long
subStructureTypes	List of StructureTypeData

listStructureMembersByCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method lists all the contact matching the give search criterion

Parameters

structureContactNumber	String (20)	Mandatory Mandatory, the number to identify the structure contact
memberContactNumber	String (20)
roles	List of (MEMBER\|PARTNER\|PRODUCER\| PUBLIC\|RELAY\|SUPPLIER\| GUIDE\|CONTRACTOR\|SUPPORT\| EXHIBITOR\|ARTIST)	Optional, allows to filter the contacts by the role
login	String	Optional
state	String	Optional
firstname	String	Optional, filter the contact whom first name starts with the give value
lastname	String	Optional, filter the contact whom last name starts with the give value
startPosition	Long	Mandatory Mandatory, for pagination purpose, return the contacts from the given index
maxResults	Long	Mandatory Mandatory, for pagination purpose, return the contacts until the given index

Return value

StructureMemberContactListResult

structureMemberContactData	List of StructureMemberContactData
requestId	Integer
statusCode	String (8)
statusDetail	String

StructureMemberContactData

active	boolean
contactNumber	String (20)
function	String
individualContactData	IndividualContactData
login	String
modifiable	boolean
password	String
primaryContactNumber	String (20)
role	(MEMBER\|PARTNER\|PRODUCER\| PUBLIC\|RELAY\|SUPPLIER\| GUIDE\|CONTRACTOR\|SUPPORT\| EXHIBITOR\|ARTIST)
state	(VALID\|INVALIDATED\| PENDING\|REJECTED\| DUPLICATE)
structureContactNumber	String (20)
requestId	Integer
statusCode	String (8)
statusDetail	String

saveIndividualContactData

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method allows to create or update a contact of type individual.

To create a "standard" individual, pass role=PUBLIC.

To update only specific information, pass the contact number and the list of informations to be udated (addresses, criteria...)

Updating a list of addresses (resp. criteria, authorizations, contact connections)

if fullAddresses = true, the list of provided addresses will replace the current list of addresses of the contact.

if fullAddresses = false, any address with an existing addressId will be updated, any address without an id will be added

Ids of the added items can be retrieved in the return values of the function.

Same behavior to update criteria, authorizations, connections.

Concerning postal normalization, see general documentation of the service.

When creating an account, an email is sent to the contact to confirm inscription.

About postal normalization

If no postal normalization is activated, any new address will be saved with normalizationRating=UNKNOWN, and normalizationState=TO_BE_NORMALIZED and nothing else will occurr.

Else, many cases may happen.

Address is saved (contactAddressId != null) and normalizationState=NORMALIZED. That means the normalization service has been called, did recognise the address and did save it, fixing only minor typos if needed.
Address has normalizationState=NOT_NORMALIZED : the system did not recognise it and the front-end must ask the client to fix it. After that, the subsequent save can be done with state=TO_BE_NORMALIZED or state NOT_TO_BE_NORMALIZED if we want to force the save.
Address returns with state NOT_TO_BE_NORMALIZED. Nothing more can be done.

In any case, if the address persisted is different from the address entered, the entered address is returned with contactAddressId==null (this one has not been saved) in order to allow the front-end to display the comparison between both addresses.

Parameters

contactNumber	String (20)	Optional : the contact number. If empty, a new contact is created.
individualContactData	IndividualContactData	DTO contains information about the contact to be saved
addresses	List of ContactAddressData
fullAddresses	boolean	Mandatory
authorizations	List of AuthorizationData	Optional, the list of authorizations
fullAuthorizations	Boolean
doubleOptInForAuthorizations	Boolean	If set to true, authorizations accepted by the contact will be marked to true only after he/she has received an email and clicked on the confirmation link.
externalContactCriterionData	List of ExternalContactCriterionData
fullContactCriteria	boolean	Mandatory
contactConnections	List of ContactConnection	connections to add to the created/updated contact
fullContactConnections	boolean	Mandatory if true, the provided contact connections is the entire list of connections for this contact, o.w. they connections will be updated with the provided list
socialConnections	List of ContactSocialConnection
fullSocialConnections	boolean	Mandatory
campaignTrackerId	String	the tracker id of the campaign associated with this account creation (null if none)
individualPhotoData	IndividualPhotoData	contains the photo of the individual. If passed as null, nothing is changed. If individual contains empty filename, photo is removed. Else photo is updated.
contactOrigin	String	Specify the origin of contact

ContactConnection

contactConnectionId	Long
contactNumber	String (20)
isParentContact	boolean
type	(DISTRIBUTION_PARTNER\| MEMBER\|STRUCT_MEMBER\| FAMILY\|SPONSOR\| SHIPMENT_CONTACT\| SUBGROUP_MEMBER\| INVOICE_CONTACT\| INVOICE_ENTITY\|ATR)

Return value

ContactDataResult

saveStructureAdministrativeNumbers

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method saves the list of administrative numbers for the given structure. If the contact already has the administrative numbers, they will be updated if provided in the new list or removed if not included in the new list.

Parameters

contactNumber	String (20)	Mandatory Mandatory, the number to identify the contact
administrativeNumbers	List of ExternalAdministrativeNumberData	Mandatory Mandatory, the list of administrative numbers

Return value

StructureAdministrativeNumbersResult

saveStructureContactData

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method allows to modify or create a contact of the type structure. Its behavior is similar to the one of saveIndividualContactData.

Parameters

contactNumber	String (20)	TODO
structureContactData	StructureContactData	DTO contains information about the contact to be saved
addresses	List of ContactAddressData
fullAddresses	Boolean
authorizations	List of AuthorizationData
fullAuthorizations	Boolean
externalContactCriterionData	List of ExternalContactCriterionData
fullContactCriteria	Boolean
contactConnections	List of ContactConnection
fullContactConnections	Boolean
administrativeNumbers	List of ExternalAdministrativeNumberData

Return value

ContactDataResult

saveStructureContacts

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method create/update a list of structure contacts. The api processes atomic update of each structure contact {@link StructureContactDataComplete} in the same order as provided and returns the result {@link ContactDataResult } for each such update in an ordered list inside {@link ContactDataListResult}

Parameters

structureContacts

List of StructureContactDataComplete

Mandatory
Mandatory, there should be atleast one structure to be updated. The limit on max number of members which can be created/updated is 10000

StructureContactDataComplete

structureContactData	StructureContactData
addresses	List of ContactAddressData
administrativeNumbers	List of ExternalAdministrativeNumberData
authorizations	List of AuthorizationData
campaignTracker	String
contactConnections	List of ContactConnection
externalContactCriterionData	List of ExternalContactCriterionData
fullAddresses	Boolean
fullAuthorizations	Boolean
fullContactConnections	Boolean
fullContactCriteria	Boolean
pointOfSalesId	Long

Return value

ContactDataListResult

contactDatas	List of ContactDataResult
requestId	Integer
statusCode	String (8)
statusDetail	String

saveStructureMember

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method allows to modify or create a contact member of a structure. The status of the newly created contact is PENDING ; the account will be validated and activated by a backoffice operator. Its state will change to VALID if accepted and REJECTED otherwise

Parameters

structureMemberContactData

StructureMemberDataComplete

DTO contains information about the contact to be saved

StructureMemberDataComplete

structureMember	StructureMemberContactData	Mandatory parameter
addresses	List of ContactAddressData
administrativeNumbers	List of ExternalAdministrativeNumberData
authorizations	List of AuthorizationData
campaignTracker	String
contactConnections	List of ContactConnection
externalContactCriterionData	List of ExternalContactCriterionData
fullAddresses	Boolean
fullAuthorizations	Boolean
fullContactConnections	Boolean
fullContactCriteria	Boolean
pointOfSalesId	Long

Return value

StructureMemberContactResult

addresses	List of ContactAddressData
authorizations	List of AuthorizationData
contactConnections	List of ContactConnectionDetailed
contactCriteria	List of ExternalContactCriterionData
contactNumber	String (20)
function	String
individualContactData	IndividualContactData
login	String
password	String
role	(MEMBER\|PARTNER\|PRODUCER\| PUBLIC\|RELAY\|SUPPLIER\| GUIDE\|CONTRACTOR\|SUPPORT\| EXHIBITOR\|ARTIST)
state	(VALID\|INVALIDATED\| PENDING\|REJECTED\| DUPLICATE)
structureContactNumber	String (20)
requestId	Integer
statusCode	String (8)
statusDetail	String

saveStructureMembers

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method create/update a list of structure members. The api processes atomic update of each structure member {@link StructureMemberDataComplete} in the same order as provided and returns the result {@link StructureMemberContactResult } for each such update in an ordered list inside {@link StructureMemberContactListResult}

Parameters

structureMembers

List of StructureMemberDataComplete

Mandatory
Mandatory, there should be atleast one member to be updated. The limit on max number of members which can be created/updated is 10000 The status of the newly created contact is PENDING ; the account will be validated and activated by a backoffice operator. Its state will change to VALID if accepted and REJECTED otherwise
The following error codes can be returned: The following error codes can be returned:

error.contact.wrongContactNumber: the given member contact or the structure contact does not exist;
error.contact.limitExceeded: when number of members to be updated are more than 20;

Return value

StructureMemberCompleteListResult

structureMemberContactData	List of StructureMemberContactResult
requestId	Integer
statusCode	String (8)
statusDetail	String

searchByFileHistory

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method return information of contacts that are linked to files owned by given contact

Parameters

fileHistoryContactSearch

FileHistoryContactSearch

FileHistoryContactSearch

endDate	Date	Date of after creation file
fileOwnerContactNumber	String (20)	File contact of type OWNER
startDate	Date	Date of before creation file

Return value

FileHistoryContactListResult

fileHistoryContactResults	List of FileHistoryContactData
requestId	Integer
statusCode	String (8)
statusDetail	String

FileHistoryContactData

contactNumber	String (20)
fileContactType	(SALE\|OWNER\|FINDER\| COMM_ENTITY)
fileId	long
name	String
structureName	String

searchContactByCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Allow to search for contacts passing a choice of filters : contact reference, roles, connections, email, phone, etc.

Parameters

contactReference	String (20)
contactRoles	List of (MEMBER\|PARTNER\|PRODUCER\| PUBLIC\|RELAY\|SUPPLIER\| GUIDE\|CONTRACTOR\|SUPPORT\| EXHIBITOR\|ARTIST)
contactConnections	List of ContactConnection
contactDetails	List of (GENERAL\|QUALITIES\| AUTHORIZATIONS\|CRITERIA\| INDICATORS\|ADVANTAGES\| ADDRESSES\|COM_MEANS\| FINANCIAL\|CONNECTIONS\| INDIVIDUAL_PHOTO\| INVALIDATED_QUALITIES)
socialConnections	List of ContactSocialConnection
phone	String
structureContactNumber	String (20)
contactTextSearch	ContactTextSearch
contactType	(INDIVIDUAL\|STRUCTURE)
includeWithoutConnection	boolean	Mandatory Optional. If true, search for all contacts, including the ones not having a login. If not defined, set to false.
startPosition	Long
maxResults	Long

ContactTextSearch

contactFileHistoryCriteria	ContactFileHistoryCriteria	Provide a criteria on contacts result to know if contacts are purchasers or billers of a given file contact number
searchFields	List of (NAME\|STRUCTURE_NAME\| EMAIL\|ADDRESS\|LOGIN\| NUMBER\|CARD_ID\|BADGE_ID)
searchText	String

Return value

ContactSearchResult

contacts	List of ContactDataResult
requestId	Integer
statusCode	String (8)
statusDetail	String

unsubscribeContact

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

hashIdentifier

String

Return value

ContactAuthorizationResult

contactAuthorization	ContactAuthorizationData
requestId	Integer
statusCode	String (8)
statusDetail	String

ContactAuthorizationData

authorizationsData	List of AuthorizationData