GroupService Operations
For a list of the operations associated with this Web service, see the following table.
| Name | Description |
|---|---|
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 the following table.
| Node | Description | Type |
|---|---|---|
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 the following table.
| Node | Description | Type |
|---|---|---|
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 the following table.
| Node | Description | Type |
|---|---|---|
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 the following table.
| Node | Description | Type |
|---|---|---|
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 the following table.
| Node | Description | Type |
|---|---|---|
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 the following table.
| Node | Description | Type |
|---|---|---|
|
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 the following table.
| Node | Description | Type |
|---|---|---|
|
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 the following table.
| Node | Description | Type |
|---|---|---|
|
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 |