URL: | ||
JWT Token | ||
Template: | ||
cURL: |
Version: 2_22 (other versions, change log, ZUMSTEIN_V3.12-SNAPSHOT) Active version. This version can be subject to minor retro-compatible changes without warnings.
SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnco/external-remoting/com.secutix.service.contact.v2_22.ContactInformationPublicService.webservice?wsdl
REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnco/backend-apis/contactInformationPublicService/v2_22/{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.
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method allows to activate the connection of contact and identified contact by token which is already sent by secure one-time reset link
token | String | Mandatory requested activate contact connection token to validate and activate the connection, mandatory |
ContactConnectionActivationResult | ||
childContactNumber | String (20) | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
contactDataList | List of CulturalContactData |
CulturalContactData | ||
contactNumber | String (20) | |
createLogin | boolean | |
String | ||
firstName | String | |
identifier | Long | |
isRequiredAccountVerificationEmail | Boolean | This field use to required perform action send verification email. If not defined, set to false. |
lastName | String | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
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 | |
contactBallotData | List of ContactBallotData | |
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 | |
contactPermission | Map of String, Boolean | |
contactQualities | List of ContactQuality | |
creationDate | Date | |
dateLastModified | 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) | |
dateLastModified | Date |
ContactBallotData | ||
availabilityLevel | (GOOD|LIMITED) | |
ballotId | Long | |
fileId | Long | |
indicatorId | Long | |
indicatorLevelExpression | String | |
orderDate | Date | |
orderId | Long | |
targetType | (PUBLIC|CONTACT) |
ContactConnectionDetailed | ||
chidStructureContactData | StructureContactData | |
childIndividualContactData | IndividualContactData | |
parentIndividualContactData | IndividualContactData | |
parentStructureContactData | StructureContactData | |
contactConnectionId | Long | |
contactNumber | String (20) | |
isParentContact | boolean | |
status | (ACTIVE|PENDING) | |
type | (DISTRIBUTION_PARTNER| MEMBER|STRUCT_MEMBER| FAMILY|SPONSOR| SHIPMENT_CONTACT| SUBGROUP_MEMBER| INVOICE_CONTACT| INVOICE_ENTITY|ATR| PROMOTER|SALES_REP) |
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) | |
String | ||
email1VerificationStatus | String | Status of the email verification. Possible values : UNVERIFIED, VERIFIED |
faxNumber | String | Fax number. E164 format. +41214232222 |
isRequiredAccountVerificationEmail | Boolean | This field use to required perform action send verification email. If not defined, set to false. |
isVerifiedEmail | Boolean | Status to check if the email is verified or not. |
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 | |
bicNumber | String | |
blocked | Boolean | |
cellPhoneNumber | String | Cell phone number, internationalized. E164 format. +41797894554 |
cellPhoneNumberVerified | boolean | |
confidentialityLevelEnum | (FREE|RESTRICTED| CONFIDENTIAL) | |
contactBlockedReasonCode | String (8) | |
contactNumber | String (20) | |
countryCode | String (8) | |
digestedPassword | String | |
String | ||
email1VerificationStatus | String | Status of the email verification. Possible values : UNVERIFIED, VERIFIED |
encryptedPassword | String | |
endValidityDate | Date | |
endValidityReason | String | |
faxNumber | String | Fax number. E164 format. +41214232222 |
handicapType | String | |
ibanNumber | 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 | |
isRequiredAccountVerificationEmail | Boolean | This field use to required perform action send verification email. If not defined, set to false. |
isVerifiedEmail | Boolean | Status to check if the email is verified or not. |
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) | |
membershipSupportPartnerOrganization | boolean | |
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|SPORTSALLIANCE| OPENFIELD|SAML_SP) | |
providerUserReference | String |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
contactNumber | String (20) | |
deleteStrict | boolean | Mandatory |
ContactDeleteResult | ||
contactInfo | List of String | |
isContactDeletetable | boolean | |
expectedException | boolean | |
statusMessage | String | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method remove address book.
addressBookEntryId | Long | Mandatory Mandatory, the id to identify the address book |
ownerContactNumber | String (20) | Mandatory Mandatory, the number to identify the contact |
WebMethodResult2 | ||
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method remove a contact member of a structure.
contactNumber | String (20) | Mandatory Mandatory, the number to identify the contact |
structureContactNumber | String (20) |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
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 |
FastContactSearchResult | ||
contacts | List of ContactDataResult | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
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
contactNumber | String (20) | |
addresses | List of ContactAddressData |
ContactAddressesResult | ||
contactAddressesData | ContactAddressesData | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
ContactAddressesData | ||
addressesData | List of ContactAddressData |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
Generates a contact support token for the given contact and point of sale.
contactNumber | String (20) | The contact for which the token is to be generated. |
pointOfSaleId | Long | The point of sale. |
ContactTokenGenerationResult | ||
contactToken | String | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method return all the address book by ids
addressBookEntryIds | List of Long | Mandatory Mandatory, the list address book entry id for search |
AddressBookEntriesDataResult | ||
addressBookEntriesInfo | List of AddressBookEntryInfo | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
AddressBookEntryInfo | ||
addressBookEntryId | Long | |
givenCompany | String | |
givenEmail | String | |
givenFirstname | String | |
givenLastname | String | |
ownerContactNumber | String (20) | |
targetContactNumber | String (20) |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method lists all the address book belong to owner contact
ownerContactNumber | String (20) | Mandatory Mandatory, the number to identify the owner contact |
startPosition | Long | Optional, for pagination purpose, return the contacts from the given index |
maxResults | Long | Optional, for pagination purpose, return the contacts until the given index |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
contactNumber | String (20) | |
advantageType | (PUBLIC|CODE|CONTACT) |
ContactAdvantageResult | ||
contactAdvantagesData | ContactAdvantagesData | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
ContactAdvantagesData | ||
advantagesData | List of ContactAdvantageData |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
contactNumber | String (20) | |
advantageSearchCriteria | AdvantageSearchCriteria |
AdvantageSearchCriteria | ||
advantagePeriod | (ON_SALE|FUTURE) | |
advantageType | (PUBLIC|CODE|CONTACT) |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method returns all the active contact criterion for the institution. This list does not depend on the point of sales configuration and changes rarely, so it is requested that the result of this method should be cached in the caller side for at least 30 minutes.
ExternalContactCriterionResult | ||
contactCriterionDefinitionDatas | List of ExternalContactCriterionDefinitionData | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
ExternalContactCriterionDefinitionData | ||
availableOnPOS | boolean | |
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 | |
internalName | MultiLingual | |
mandatory | Boolean | |
rank | Integer | |
screenVisibilityType | (CONTACT_CRITERION| AUTOMATIC_CUP_SCHEME| MANAGEMENT_FINANCIAL| RECURRING_DONATION| PMA_TAG_PROCESS| APPLICATION) | |
target | (INDIVIDUAL|STRUCTURE| BOTH) | |
visibility | (NONE|READ|UPDATE) |
ContactCriterionElementDefinition | ||
code | String (8) | |
idCode | String (8) | |
rank | Integer | |
value | MultiLingual |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method return all known administrative numbers.
AvailableAdministrativeNumbersResult | ||
externalAdministrativeNumberDefinitionData | List of ExternalAdministrativeNumberDefinitionData | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
ExternalAdministrativeNumberDefinitionData | ||
adminNumCode | String (8) | |
adminNumIdCode | String (8) | |
externalName | MultiLingual | |
rank | Integer |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method returns the list of all available authorizations.
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) |
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.
ExternalContactCriterionResult
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method return all known administrative numbers.
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 |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method returns all the available locality criterion elements.
countryCodes | List of String | Optional, list of country codes in ISO-Alpha-2 format. The result is filtered by country codes if provided. |
LocalityCriterionElementListResult | ||
Created by asi on 08.08.2017. | ||
elements | List of LocalityCriterionElement | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method return an email list of blocked emails if there is an blocked contact with this email
emails | List of String |
BlockedEmailsResult | ||
blockedEmails | List of String | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
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.
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| ADVANTAGES_FUTURE| ADDRESSES|COM_MEANS| FINANCIAL|CONNECTIONS| INDIVIDUAL_PHOTO| INVALIDATED_QUALITIES| PERMISSIONS|BALLOT) | A list of ContactDetailsEnum specifying additional details to include in the contact data.
Possible values for the details parameter include:
The following error codes can be returned:
|
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.
contactNumber | List of String | Mandatory Mandatory, the number used to identify the contact |
details | List of (GENERAL|QUALITIES| AUTHORIZATIONS|CRITERIA| INDICATORS|ADVANTAGES| ADVANTAGES_FUTURE| ADDRESSES|COM_MEANS| FINANCIAL|CONNECTIONS| INDIVIDUAL_PHOTO| INVALIDATED_QUALITIES| PERMISSIONS|BALLOT) |
ContactsDataResult | ||
contactsData | List of ContactDataResult | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
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}
screenNames | List of String | Mandatory Mandatory, list of names of screens for which the layout is required |
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| HIDDEN_UNCHECKED| HIDDEN_CHECKED) |
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.
structureContactNumber | String (20) | |
adminNumIdCodes | List of String |
StructureAdministrativeNumbersResult | ||
externalAdministrativeNumberData | List of ExternalAdministrativeNumberData | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
ExternalAdministrativeNumberData | ||
adminNumIdCode | String (8) | |
value | String |
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.
StructureTypesResult | ||
structureTypeData | List of StructureTypeData | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
StructureTypeData | ||
code | String (8) | |
externalName | MultiLingual | |
id | Long | |
subStructureTypes | List of StructureTypeData |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method lists all producer opt-in information for the given contact and POS, also from order if provided
contactNumber | String (20) | Mandatory contact number to retrieve information, mandatory |
posId | Long | Mandatory point of sales id, mandatory |
orderId | Long | if provided, also retrieve the producers associate to order, optional |
ContactProducerOptInListResult | ||
contactProducerOptIns | List of ContactProducerOptInData | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
ContactProducerOptInData | ||
description | MultiLingual | |
producer | ProducerData | |
value | Boolean |
ProducerData | ||
contactNumber | String (20) | |
officialName | String |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method lists all the contact matching the give search criterion
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 |
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 |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method use to create or update an address book of a specific contact
addressBookInfo | AddressBookEntryInfo |
SaveAddressBookOfContactResult | ||
addressBookEntryInfo | AddressBookEntryInfo | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method create or update the producer consents for the given contact then send an authorization confirmation email to all registered producers
contactNumber | String (20) | Mandatory contact number to create/update the producer consent, mandatory |
posId | Long | Mandatory point of sales id, mandatory |
contactProducersConsent | List of ContactProducerConsentData | Mandatory list producer consent, mandatory |
ContactProducerConsentData | ||
producerContactNumber | String (20) | |
value | Boolean |
SaveContactProducerConsentResult | ||
contactProducerConsentFailures | List of ContactProducerConsentFailure | |
hasPendingProducerConsent | boolean | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
ContactProducerConsentFailure | ||
contactProducerConsent | ContactProducerConsentData | |
failureReason | String |
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.
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 | |
status | (ACTIVE|PENDING) | |
type | (DISTRIBUTION_PARTNER| MEMBER|STRUCT_MEMBER| FAMILY|SPONSOR| SHIPMENT_CONTACT| SUBGROUP_MEMBER| INVOICE_CONTACT| INVOICE_ENTITY|ATR| PROMOTER|SALES_REP) |
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.
contactNumber | String (20) | Mandatory Mandatory, the number to identify the contact |
administrativeNumbers | List of ExternalAdministrativeNumberData | Mandatory Mandatory, the list of administrative numbers |
StructureAdministrativeNumbersResult
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.
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 |
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}
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 |
ContactDataListResult | ||
contactDatas | List of ContactDataResult | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
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
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 |
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 |
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}
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:
|
StructureMemberCompleteListResult | ||
structureMemberContactData | List of StructureMemberContactResult | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method return information of contacts that are linked to files owned by given contact
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 |
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 |
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.
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| ADVANTAGES_FUTURE| ADDRESSES|COM_MEANS| FINANCIAL|CONNECTIONS| INDIVIDUAL_PHOTO| INVALIDATED_QUALITIES| PERMISSIONS|BALLOT) | |
socialConnections | List of ContactSocialConnection | |
phone | String | |
structureContactNumber | String (20) | |
contactTextSearches | List of ContactTextSearch | Optional. Search will try to find which meet requirements of all contactTextSearches |
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. |
parentStructureContactNumber | String (20) | Optional. Specify the contactNumber for the parent structure which the search results will be limited. |
includeOnlyOrphanStructures | boolean | Mandatory Optional. If true, search only contacts with no parent contact number. If not defined, set to false and all contacts are retrieved. |
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 |
ContactSearchResult | ||
contacts | List of ContactDataResult | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
send verification email if email hasn't been verified yet and return message that email has been sent.
String | Mandatory Mandatory, the email need to send email to verify | |
contactNumber | String (20) | Mandatory Mandatory, the contact number need to send email to verify |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method send a consent email to the linkedContact
contactNumberParent | String | Mandatory Mandatory, the number to identify the contact parent |
contactNumberChild | String | Mandatory Mandatory, the number to identify the contact child |
contactConnectionId | String | The number id to identify the contact connection between father and child |
WebMethodResult | ||
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method use to submit the producer consents for the given contact.Update the state of the contact producer opt in to CONFIRMED
contactNumber | String (20) | Mandatory contact number to submit the producer consent, mandatory |
producerContactNumbers | List of String | Mandatory list producer numbers, mandatory |
SubmitProducerConsentResult | ||
submittedProducerFailures | List of SubmittedProducerFailure | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
SubmittedProducerFailure | ||
failureReason | String | |
producerContactNumber | String (20) |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
hashIdentifier | String |
ContactAuthorizationResult | ||
contactAuthorization | ContactAuthorizationData | |
requestId | Integer | |
statusCode | String (8) | |
statusDetail | String |
ContactAuthorizationData | ||
authorizationsData | List of AuthorizationData |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
Update contact financial authority data like: allow payment by waiting account, set max waiting account balance
contactNumber | String (20) | Mandatory Mandatory, the number to identify the contact |
financialAuthorityData | FinancialAuthorityData | Mandatory Mandatory, the financial authority data need to be updated. |
FinancialAuthorityData | ||
waitingAccountAllowed | Boolean | Allow contact to pay by waiting account payment method |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This API is to link/unlink contact to structure
contactStructureLink | ContactStructureLink |
ContactStructureLink | ||
action | (LINK|UNLINK) | |
contactNumber | String (20) | |
structureContactNumber | String (20) |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
Update contact financial bank mandate data: update iban number, bic number, mandate reference(UMR), mandate signature date.
contactNumber | String (20) | Mandatory Mandatory, the number to identify the contact |
financialBankMandateData | FinancialBankMandateData | Mandatory Mandatory, DTO contains information about the contact financial bank mandate (iban number, bic number, mandate reference(UMR), mandate signature date) data to be updated. |
readOnlyAttribute | (BANK_DETAILS| MANDATE_DETAILS) | Optional.
If read-only attribute is BANK_DETAILS, not update bank details (iban number, bic number)
and update mandate details (mandate reference(UMR), mandate signature date) with the provided financial mandate data.
If read-only attribute is MANDATE_DETAILS, not update mandate details (mandate reference(UMR), mandate signature date) and update bank details (iban number, bic number) with the provided financial bank data. If read-only attribute is empty, the provided financial bank mandate (not null) will replace the current financial bank mandate of the contact. If read-only attribute is empty and all attributes of provided financial bank mandate are null, the current contact financial bank mandate data will be updated with null value. |
FinancialBankMandateData | ||
agreementReference | String | contact's agreement reference information |
agreementSigningDate | Date | contact agreement reference information |
bic | String | contact's bic number information |
iban | String | contact's iban number information |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method is used to validate secure one-time reset link is not expired by token
token | String | Mandatory requested activate contact connection token, mandatory |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This method is used to validate secure one-time contact support link is not expired by token
token | String | Mandatory requested contact support token, mandatory |
REST_RPC | MOSA | CUBE | PLAY |
SOAP | MOSA | CUBE | PLAY |
This API is to verify contact email
token | String | Mandatory Mandatory, the token after encrypting by api sendAccountVerificationEmail |