|
Oracle Customer Hub (UCM) Master Data Management Reference > Oracle Customer Hub (UCM) and Data Governance Manager Web Services Reference >
PersonService
Use this Web service to create, update, retrieve and delete Person records. PersonService Operations
For a list of the operations associated with this Web service, see Table 138
Table 138. PersonService Operations
|
|
createPerson |
Creates a person record. |
updatePerson |
Updates an existing person record. |
deletePerson |
Deletes a person record. |
getPerson |
Retrieves person records based on a user query. |
. Request Message Description: createPerson
For a description of this request message, see Table 139.
Table 139. Request Message Description: createPerson
|
|
|
SwiPersonIO |
Required. An instance of the integration object, SwiPersonIO. Contact is the parent header and the following are the child. |
Integration Object |
The following nodes apply to SwiPersonIO |
Id |
Row ID of the record in the requesting system cross-reference ID. |
String |
CellularPhone |
Contact's mobile phone number. |
String |
BirthDate |
Contact's birth date. |
String |
EmailAddress |
Contact's email address. |
String |
FaxPhone |
Contact's fax number. |
String |
FirstName |
Contact's first name. |
String |
HomePhone |
Contact's home phone number. |
String |
Income |
Contact's income. |
String |
IncomeCurrencyCode |
Income currency code. |
String |
IntegrationId |
Integration ID. |
String |
LastName |
Contact's last name. |
String |
MF |
Male or female. |
String |
MM |
Mr. or Ms. |
String |
ManagerIntegrationId |
Manager's integration ID. |
String |
MaritalStatus |
Contact's marital status. |
String |
MiddleName |
Contact's middle name. |
String |
MotherMaidenName |
Contact's mothers' maiden name |
String |
PartyUId |
Party unique ID. |
String |
PersonUId |
Person user ID. |
String |
PreferredCommunications |
Contact's preferred communication method. |
String |
PreferredLanguageCode |
Contact preferred language code. |
String |
SocialSecurityNumber |
Contact's social security number. |
String |
Status |
Status. |
String |
AIAUCMIntegrationId |
Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID. |
String |
ListOfContact_Account |
Optional. Account associated with the contact. |
Integration Component |
ListOfUcmContactPrivacy |
Optional. Contact's privacy details. |
Integration Component |
ListOfContact_CommunicationAddress |
Optional. Contact's communication address. |
Integration Component |
ListOfContact_AlternatePhone |
Optional. Contact's alternate phone details. |
Integration Component |
ListOfContact_Position |
Optional. Contact's positions. |
Integration Component |
ListOfContact_Households |
Optional. Contact's household. |
Integration Component |
ListOfContact_INSPersonalAddress |
Optional. Contact's personal address details. |
Integration Component |
ListOfContact_Organization |
Optional. Contact's organization details. |
Integration Component |
ListOfFINCORPAccount |
Optional. Details of the associated FINCORP account. |
Integration Component |
ListOfUCMHEConstituentName |
Optional. Details of the constituent's names. |
Integration Component |
ListOfUCMHEConstituentIdentification |
Optional. Details of the constituent's identification. |
Integration Component |
ListOfUCMHEConstituentAddress |
Optional. Details of the constituent's addresses. |
Integration Component |
ListOfUCMHEConstituentAffiliation |
Optional. Details of the constituent's affiliations. |
Integration Component |
ListOfSMContactSocialProfile |
Optional. Contact's social media profile details. |
Integration Component |
ListOfSMContactSocialProfileAttributes |
Optional. Contact's social media profile attribute details. |
Integration Component |
Response Message Description: createPerson
For a description of this response message, see Table 140.
Table 140. Response Message Description: createPerson
|
|
|
SwiPersonIO |
An instance of the integration object, SwiPersonIO. Contact is the parent header. |
Integration Object |
Error Code |
Error code, if any. |
String |
Error Message |
Error message, if any. |
String |
Error Symbol |
Error symbol, if any. |
String |
Request Message Description: updatePerson
For a description of this request message, see Table 141.
Table 141. Request Message Description: updatePerson
|
|
|
SwiPersonIO |
Required. An instance of the integration object, SwiPersonIO. Contact is the parent header and the following are the child. |
Integration Object |
The following nodes apply to SwiOrganizationIO |
Id |
Row ID of the record in the requesting system cross-reference ID. |
String |
CellularPhone |
Contact's mobile phone number. |
String |
BirthDate |
Contact's birth date. |
String |
EmailAddress |
Contact's email address. |
String |
FaxPhone |
Contact's fax number. |
String |
FirstName |
Contact's first name. |
String |
HomePhone |
Contact's home phone number. |
String |
Income |
Contact's income. |
String |
IncomeCurrencyCode |
Income currency code. |
String |
IntegrationId |
Integration ID. |
String |
LastName |
Contact's last name. |
String |
MF |
Male or female. |
String |
MM |
Mr. or Ms. |
String |
ManagerIntegrationId |
Manager's integration ID. |
String |
MaritalStatus |
Contact's marital status. |
String |
MiddleName |
Contact's middle name. |
String |
MotherMaidenName |
Contact's mothers' maiden name |
String |
PartyUId |
Party unique ID. |
String |
PersonUId |
Person user ID. |
String |
PreferredCommunications |
Contact's preferred communication method. |
String |
PreferredLanguageCode |
Contact preferred language code. |
String |
SocialSecurityNumber |
Contact's social security number. |
String |
Status |
Status. |
String |
AIAUCMIntegrationId |
Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID. |
String |
ListOfContact_Account |
Optional. Account associated with the contact. |
Integration component |
ListOfUcmContactPrivacy |
Optional. Contact's privacy details. |
Integration component |
ListOfContact_CommunicationAddress |
Optional. Contact's communication address. |
Integration component |
ListOfContact_AlternatePhone |
Optional. Contact's alternate phone details. |
Integration component |
ListOfContact_Position |
Optional. Contact's positions. |
Integration component |
ListOfContact_Households |
Optional. Contact's household. |
Integration component |
ListOfContact_INSPersonalAddress |
Optional. Contact's personal address details. |
Integration component |
ListOfContact_Organization |
Optional. Contact's organization details. |
Integration component |
ListOfFINCORPAccount |
Optional. Details of the associated FINCORP account. |
Integration component |
ListOfUCMHEConstituentName |
Optional. Details of the constituent's names. |
Integration component |
ListOfUCMHEConstituentIdentification |
Optional. Details of the constituent's identification. |
Integration component |
ListOfUCMHEConstituentAddress |
Optional. Details of the constituent's addresses. |
Integration component |
ListOfUCMHEConstituentAffiliation |
Optional. Details of the constituent's affiliations. |
Integration component |
ListOfSMContactSocialProfile |
Optional. Contact's social media profile details. |
Integration Component |
ListOfSMContactSocialProfileAttributes |
Optional. Contact's social media profile attribute details. |
Integration Component |
Response Message Description: updatePerson
For a description of this response message, see Table 142.
Table 142. Response Message Description: updatePerson
|
|
|
SwiPersonIO |
An instance of the integration object, SwiPersonIO. Contact is the parent header. |
Integration Object |
Error Code |
Error code, if any. |
String |
Error Message |
Error message, if any. |
String |
Error Symbol |
Error symbol, if any. |
String |
Request Message Description: deletePerson
For a description of this request message, see Table 143.
Table 143. Request Message Description: deletePerson
|
|
|
SwiPersonIO |
Required. An instance of the integration object, SwiPersonIO. Contact is the parent header and the following are the child. |
Integration Object |
The following nodes apply to SwiOrganizationIO |
Id |
Row ID of the record in the requesting system cross-reference ID. |
String |
CellularPhone |
Contact's mobile phone number. |
String |
BirthDate |
Contact's birth date. |
String |
EmailAddress |
Contact's email address. |
String |
FaxPhone |
Contact's fax number. |
String |
FirstName |
Contact's first name. |
String |
HomePhone |
Contact's home phone number. |
String |
Income |
Contact's income. |
String |
IncomeCurrencyCode |
Income currency code. |
String |
IntegrationId |
Integration ID. |
String |
LastName |
Contact's last name. |
String |
MF |
Male or female. |
String |
MM |
Mr. or Ms. |
String |
ManagerIntegrationId |
Manager's integration ID. |
String |
MaritalStatus |
Contact's marital status. |
String |
MiddleName |
Contact's middle name. |
String |
MotherMaidenName |
Contact's mothers' maiden name |
String |
PartyUId |
Party unique ID. |
String |
PersonUId |
Person user ID. |
String |
PreferredCommunications |
Contact's preferred communication method. |
String |
PreferredLanguageCode |
Contact preferred language code. |
String |
SocialSecurityNumber |
Contact's social security number. |
String |
Status |
Status. |
String |
AIAUCMIntegrationId |
Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID. |
String |
ListOfContact_Account |
Optional. Account associated with the contact. |
Integration Component |
ListOfUcmContactPrivacy |
Optional. Contact's privacy details. |
Integration Component |
ListOfContact_CommunicationAddress |
Optional. Contact's communication address. |
Integration Component |
ListOfContact_AlternatePhone |
Optional. Contact's alternate phone details. |
Integration Component |
ListOfContact_Position |
Optional. Contact's positions. |
Integration Component |
ListOfContact_Households |
Optional. Contact's household. |
Integration Component |
ListOfContact_INSPersonalAddress |
Optional. Contact's personal address details. |
Integration Component |
ListOfContact_Organization |
Optional. Contact's organization details. |
Integration Component |
ListOfFINCORPAccount |
Optional. Details of the associated FINCORP account. |
Integration Component |
ListOfUCMHEConstituentName |
Optional. Details of the constituent's names. |
Integration Component |
ListOfUCMHEConstituentIdentification |
Optional. Details of the constituent's identification. |
Integration Component |
ListOfUCMHEConstituentAddress |
Optional. Details of the constituent's addresses. |
Integration Component |
ListOfUCMHEConstituentAffiliation |
Optional. Details of the constituent's affiliations. |
Integration Component |
ListOfSMContactSocialProfile |
Optional. Contact's social media profile details. |
Integration Component |
ListOfSMContactSocialProfileAttributes |
Optional. Contact's social media profile attribute details. |
Integration Component |
Response Message Description: deletePerson
For a description of this response message, see Table 144.
Table 144. Response Message Description: deletePerson
|
|
|
SwiPersonIO |
Required. The same request instance of the integration object, SwiPersonIO. |
Integration Object |
Error Code |
Error code, if any. |
String |
Error Message |
Error message, if any. |
String |
Error Symbol |
Error symbol, if any |
String |
Request Message Description: getPerson
For a description of this request message, see Table 145.
Table 145. Request Message Description: getPerson
|
|
|
SwiPersonIO |
Required. An instance of the integration object, SwiPersonIO. Contact is the parent header and the following are the child. |
Integration Object |
The following nodes apply to SwiOrganizationIO |
Id |
Row ID of the record in the requesting system cross-reference ID. |
String |
CellularPhone |
Contact's mobile phone number. |
String |
BirthDate |
Contact's birth date. |
String |
EmailAddress |
Contact's email address. |
String |
FaxPhone |
Contact's fax number. |
String |
FirstName |
Contact's first name. |
String |
HomePhone |
Contact's home phone number. |
String |
Income |
Contact's income. |
String |
IncomeCurrencyCode |
Income currency code. |
String |
IntegrationId |
Integration ID. |
String |
LastName |
Contact's last name. |
String |
MF |
Male or female. |
String |
MM |
Mr. or Ms. |
String |
ManagerIntegrationId |
Manager's integration ID. |
String |
MaritalStatus |
Contact's marital status. |
String |
MiddleName |
Contact's middle name. |
String |
MotherMaidenName |
Contact's mothers' maiden name |
String |
PartyUId |
Party unique ID. |
String |
PersonUId |
Person user ID. |
String |
PreferredCommunications |
Contact's preferred communication method. |
String |
PreferredLanguageCode |
Contact preferred language code. |
String |
SocialSecurityNumber |
Contact's social security number. |
String |
Status |
Status. |
String |
AIAUCMIntegrationId |
Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID. |
String |
ListOfContact_Account |
Optional. Account associated with the contact. |
Integration Component |
ListOfUcmContactPrivacy |
Optional. Contact's privacy details. |
Integration Component |
ListOfContact_CommunicationAddress |
Optional. Contact's communication address. |
Integration Component |
ListOfContact_AlternatePhone |
Optional. Contact's alternate phone details. |
Integration Component |
ListOfContact_Position |
Optional. Contact's positions. |
Integration Component |
ListOfContact_Households |
Optional. Contact's household. |
Integration Component |
ListOfContact_INSPersonalAddress |
Optional. Contact's personal address details. |
Integration Component |
ListOfContact_Organization |
Optional. Contact's organization details. |
Integration Component |
ListOfFINCORPAccount |
Optional. Details of the associated FINCORP account. |
Integration Component |
ListOfUCMHEConstituentName |
Optional. Details of the constituent's names. |
Integration Component |
ListOfUCMHEConstituentIdentification |
Optional. Details of the constituent's identification. |
Integration Component |
ListOfUCMHEConstituentAddress |
Optional. Details of the constituent's addresses. |
Integration Component |
ListOfUCMHEConstituentAffiliation |
Optional. Details of the constituent's affiliations. |
Integration Component |
ListOfSMContactSocialProfile |
Optional. Contact's social media profile details. |
Integration Component |
ListOfSMContactSocialProfileAttributes |
Optional. Contact's social media profile attribute details. |
Integration Component |
Response Message Description: getPerson
For a description of this response message, see Table 146.
Table 146. Response Message Description: getPerson
|
|
|
SwiPersonIO |
An instance of the integration object, SwiPersonIO. Contact is the parent header. |
Integration Object |
Error Code |
Error code, if any. |
String |
Error Message |
Error message, if any. |
String |
Error Symbol |
Error symbol, if any. |
String |
PersonService Application Interface
This topic describes the application objects called by this Web service. For more information on application interfaces, refer to your application development documentation on Oracle Technology Network. Service Object (Business Service or Workflow)
For a description of the service objects for this Web service, see Table 147.
Table 147. PersonService Service Object
|
|
|
PersonService |
Workflow: UCM Person Customer Profile Integration SOAP Process. The process properties for this workflow are as follows:
- RealtimePubSub. The default value is True.
- Turn On CDM Cleanse. The default value is False.
- Turn on CDM Exact Match. The default value is False.
- Turn on CDM Match. The default value is False.
- Turn on Survivorship. The default value is False.
|
Not applicable |
Data Object (Integration Object)
For a description of the data objects for this Web service, see Table 148.
Table 148. PersonService Data Object
|
|
SwiPersonIO |
Contact |
Methods
For a description of the methods for this Web service, see Table 149.
Table 149. PersonService Methods
|
|
createPerson |
RunProcess |
updatePerson |
RunProcess |
deletePerson |
RunProcess |
getPerson |
RunProcess |
|
