|
Oracle Customer Hub (UCM) Master Data Management Reference > Oracle Customer Hub (UCM) and Data Governance Manager Web Services Reference >
GroupService
Use this Web service to perform all operations related to Households (Groups). UCM Household messages are used in insert, query, update and delete operations to maintain Household information. GroupService Operations
For a list of the operations associated with this Web service, see Table 151
Table 151. GroupService Operations
|
|
createGroup |
Creates a new group record. |
updateGroup |
Updates and existing group record. |
deleteGroup |
Deletes a group record. |
getGroup |
Retrieves group records, based on a user query. |
. Request Message Description: createGroup
For a description of this request message, see Table 152.
Table 152. Request Message Description: createGroup
|
|
|
SwiGroupIO |
Required. An instance of the integration object, SwiGroupIO. Household is the parent header and the following are the child |
Integration Object |
The following nodes apply to SwiGroupIO |
Id |
Row ID of the record in the requesting system cross-reference ID. |
String |
HouseholdName |
Name of the household. |
String |
HouseholdNumber |
Household number. |
String |
IntegrationId |
Integration ID. |
String |
Name |
Household name. |
String |
PartyUId |
Party unique ID. |
String |
PhoneNumber |
Phone number. |
String |
PrivacyCode |
Privacy code |
String |
AIAUCMIntegrationId |
Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID |
String |
HouseholdLink |
Household link |
String |
LengthOfResidence |
Length of residence |
String |
HomeOwnerRenter |
Rental home owner |
String |
ListOfHousehold_HouseholdAddress |
Optional. Household address. |
Integration Component |
ListOfHousehold_Position |
Optional. Positions of the household |
Integration Component |
ListOfUCMFINCORPAccountPrivacy |
Optional. Privacy details of the FINCORP account |
Integration Component |
ListOfContact |
Optional. Contact details of the household |
Integration Component |
ListOfHousehold_Organization |
Optional. Organization details related to the household. |
Integration Component |
Response Message Description: createGroup
For a description of this response message, see Table 153.
Table 153. Response Message Description: createGroup
|
|
|
SwiGroupIO |
An instance of the integration object, SwiGroupIO, with the list of records operated. Household 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: updateGroup
For a description of this request message, see Table 154.
Table 154. Request Message Description: updateGroup
|
|
|
SwiGroupIO |
Required. An instance of the integration object, SwiGroupIO. Household is the parent header and the following are the child |
Integration Object |
The following nodes apply to SwiGroupIO |
Id |
Row ID of the record in the requesting system cross-reference ID. |
String |
HouseholdName |
Name of the household. |
String |
HouseholdNumber |
Household number. |
String |
IntegrationId |
Integration ID. |
String |
Name |
Household name. |
String |
PartyUId |
Party unique ID. |
String |
PhoneNumber |
Phone number. |
String |
PrivacyCode |
Privacy code |
String |
AIAUCMIntegrationId |
Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID |
String |
HouseholdLink |
Household link |
String |
LengthOfResidence |
Length of residence |
String |
HomeOwnerRenter |
Rental home owner |
String |
ListOfHousehold_HouseholdAddress |
Optional. Household address. |
Integration Component |
ListOfHousehold_Position |
Optional. Positions of the household. |
Integration Component |
ListOfUCMFINCORPAccountPrivacy |
Optional. Privacy details of the FINCORP account |
Integration Component |
ListOfContact |
Optional. Contact details of the household. |
Integration Component |
ListOfHousehold_Organization |
Optional. Organization details related to the household. |
Integration Component |
Response Message Description: updateGroup
For a description of this response message, see Table 155.
Table 155. Response Message Description: updateGroup
|
|
|
SwiGroupIO |
An instance of the integration object, SwiGroupIO, with the list of records operated. Household 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: deleteGroup
For a description of this request message, see Table 156.
Table 156. Request Message Description: deleteGroup
|
|
|
SwiGroupIO |
Required. An instance of the integration object, SwiGroupIO. Household is the parent header and the following are the child |
Integration Object |
The following nodes apply to SwiGroupIO |
Id |
Row ID of the record in the requesting system cross-reference ID. |
String |
HouseholdName |
Name of the household. |
String |
HouseholdNumber |
Household number. |
String |
IntegrationId |
Integration ID. |
String |
Name |
Household name. |
String |
PartyUId |
Party unique ID. |
String |
PhoneNumber |
Phone number. |
String |
PrivacyCode |
Privacy code |
String |
AIAUCMIntegrationId |
Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID. |
String |
HouseholdLink |
Household link |
String |
LengthOfResidence |
Length of residence |
String |
HomeOwnerRenter |
Rental home owner |
String |
ListOfHousehold_HouseholdAddress |
Optional. Household address. |
Integration Component |
ListOfHousehold_Position |
Optional. Positions of the household. |
Integration Component |
ListOfUCMFINCORPAccountPrivacy |
Optional. Privacy details of the FINCORP account |
Integration Component |
ListOfContact |
Optional. Contact details of the household. |
Integration Component |
ListOfHousehold_Organization |
Optional. Organization details related to the household. |
Integration Component |
Response Message Description: deleteGroup
For a description of this response message, see Table 157.
Table 157. ResponseMessage Description: deleteGroup
|
|
|
SwiGroupIO |
Required. The same request instance of the integration object, SwiGroupIO. |
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: getGroup
For a description of this request message, see Table 158.
Table 158. Request Message Description: getGroup
|
|
|
SwiGroupIO |
Required. An instance of the integration object, SwiGroupIO. Household is the parent header and the following are the child |
Integration Object |
The following nodes apply to SwiGroupIO |
Id |
Row ID of the record in the requesting system cross-reference ID. |
String |
HouseholdName |
Name of the household. |
String |
HouseholdNumber |
Household number. |
String |
IntegrationId |
Integration ID. |
String |
Name |
Household name. |
String |
PartyUId |
Party unique ID. |
String |
PhoneNumber |
Phone number. |
String |
PrivacyCode |
Privacy code |
String |
AIAUCMIntegrationId |
Oracle Application Integration Architecture and Oracle Customer Hub (UCM) integration ID |
String |
HouseholdLink |
Household link |
String |
LengthOfResidence |
Length of residence |
String |
HomeOwnerRenter |
Rental home owner |
String |
ListOfHousehold_HouseholdAddress |
Optional. Household address |
Integration Component |
ListOfHousehold_Position |
Optional. Positions of the household. |
Integration Component |
ListOfUCMFINCORPAccountPrivacy |
Optional. Privacy details of the FINCORP account. |
Integration Component |
ListOfContact |
Optional. Contact details of the household. |
Integration Component |
ListOfHousehold_Organization |
Optional. Organization details related to the household. |
Integration Component |
Response Message Description: getGroup
For a description of this response message, see Table 159.
Table 159. Response Message Description: getGroup
|
|
|
SwiGroupIO |
An instance of the integration object, SwiGroupIO with the list of records operated. Household 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 |
GroupService 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 160.
Table 160. GroupService Service Object
|
|
|
GroupService |
Workflow: UCM Group 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 161.
Table 161. GroupService Data Object
|
|
SwiGroupIO |
Household |
Methods
For a description of the methods for this Web service, see Table 162.
Table 162. GroupService Data Object
|
|
createGroup |
RunProcess |
updateGroup |
RunProcess |
deleteGroup |
RunProcess |
getGroup |
RunProcess |
|
