Sales Cloud Household
The service used to create, update, retrieve, and delete households.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/}HouseholdService
Service WSDL URL: https://servername/crmService/HouseholdService?WSDL
Logical Business Objects
-
CRM : Trading Community Model : Household
Relationships
The following table describes how this service data object is related to other service data objects or business object services.
Relationship Type | Object or Service |
---|---|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
Operations
getHousehold
Retrieves the household based on the primary key identifier.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
PartyId |
long |
Party identifier. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
Household that matches the inbound key attributes. |
createHousehold
Creates a household and its primary address (optional).
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
household |
Sales Cloud Household |
Household to be created. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
{http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/}HouseholdResult |
Created household. |
updateHousehold
Updates a household and primary address. When updating the primary address information it is not necessary to include the primary or alternate keys for the primary address. There is a one-to-one correspondence between the account and primary address. If the alternate keys SourceSystem and SourceSystemReferenceValue in the primary address are specified and they do not match the values in the existing primary address, then a new SourceSystem/SourceSystemReferenceValue gets created for the existing primary address.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
household |
Sales Cloud Household |
Household to be updated. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
{http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/}HouseholdResult |
Updated household. |
deleteHousehold
Deletes a household and the relationship between the household and address objects indicating the address is a primary address. The address object cannot be deleted using this operation. To delete the address, use the Sales Cloud Address service.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
household |
Sales Cloud Household |
Household to be deleted. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
{http://xmlns.oracle.com/adf/svc/types/}MethodResult |
Not applicable. |
mergeHousehold
Performs a merge on the household. It will perform an update if the object exists, or an insert if the object doesn't already exist.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
household |
Sales Cloud Household |
Household to be merged. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
{http://xmlns.oracle.com/apps/crmCommon/salesParties/householdService/}HouseholdResult |
Merged household. |
findHousehold
Finds a list of households based on matching the supplied criteria pertaining to the object.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
The criteria used to limit your query result, such as the filter (where clause), the fetch size, etc. |
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
Method not currently used. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
A list of household that satisfy the inbound criteria. |
processHousehold
Performs a create, update, delete, or merge operation on a list of household rows. The specified operation is applied to all objects in the given list.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
changeOperation |
string |
Indicates what action shall be performed, such as create, update, merge, or delete. |
household |
Sales Cloud Household |
A list of households to be processed. |
processControl |
{http://xmlns.oracle.com/adf/svc/types/}ProcessControl |
Control your bulk upload behavior, such as whether the valid data will be committed if there are other invalid data in the same batch, and whether the outbound will contain the key attributes only or the full object. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
A list of household that are successfully processed. |
processCSHousehold
Performs a create, update, or delete operation on a list of household rows. Different operations may be applied to different objects, depending on what is specified in the ChangeSummary object.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
processData |
{http://xmlns.oracle.com/adf/svc/types/}ProcessData |
The object that is used to represent the changes that have been made. |
processControl |
{http://xmlns.oracle.com/adf/svc/types/}ProcessControl |
Control your bulk upload behavior, such as whether the valid data will be committed if there are other invalid data in the same batch, and whether the outbound will contain the key attributes only or the full object. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
{http://xmlns.oracle.com/adf/svc/types/}ProcessData |
Result of the operation including a list of created/updated data objects, and all warning and informational messages. |
getDfltObjAttrHints
Retrieves user interface hints, such as the service data object label and object attribute labels, for the specified service data object and locale. As a prerequisite, invoke the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
viewName |
string |
The service view usage name, an internal name for the service data object. Specify the value of the <name> element from the getEntityList operation response payload. |
localeName |
string |
The locale to use when evaluating locale-based user interface hints. The localeName is in ISO 639-1 format. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints |
The label and user interface hints for the specified service data object and its attributes in a name-value pair format. |
getServiceLastUpdateTime
Returns the date and time when the schema files referenced in the service definition last changed.
Life Cycle Status: Active
Request Payload
Response Payload
Element Name | Type | Description |
---|---|---|
result |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The date and time when the service definition last changed in ISO 8601 format. |
getEntityList
Gets the list of service data objects defined on this service.
Life Cycle Status: Active
Request Payload
Response Payload
Element Name | Type | Description |
---|---|---|
result |
{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo |
A list of service data objects defined on this service. For each service data object, the result includes the QName, internal name, and Boolean values indicating whether create, update, merge, and delete operations can be performed on the object. |
Security
The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.
Service Operations to Privileges Mapping
Operation Name | Privilege Code | Privilege Name | Privilege Description |
---|---|---|---|
getHousehold |
ZCM_VIEW_SALES_GROUP_PRIV |
View Sales Group |
Allows viewing a sales group |
mergeHousehold |
ZCM_UPDATE_SALES_GROUP_PRIV |
Update Sales Group |
Allows updating a sales group |
deleteHousehold |
ZCM_DELETE_SALES_GROUP_PRIV |
Delete Sales Group |
Allows deleting sales groups. |
processCSHousehold |
ZCM_UPDATE_SALES_GROUP_PRIV |
Update Sales Group |
Allows updating a sales group |
processCSHousehold |
ZCM_CREATE_SALES_GROUP_PRIV |
Create Sales Group |
Allows creating a sales group |
processCSHousehold |
ZCM_DELETE_SALES_GROUP_PRIV |
Delete Sales Group |
Allows deleting sales groups. |
processHousehold |
ZCM_UPDATE_SALES_GROUP_PRIV |
Update Sales Group |
Allows updating a sales group |
processHousehold |
ZCM_CREATE_SALES_GROUP_PRIV |
Create Sales Group |
Allows creating a sales group |
processHousehold |
ZCM_DELETE_SALES_GROUP_PRIV |
Delete Sales Group |
Allows deleting sales groups. |
findHousehold |
ZCM_VIEW_SALES_GROUP_PRIV |
View Sales Group |
Allows viewing a sales group |
createHousehold |
ZCM_CREATE_SALES_GROUP_PRIV |
Create Sales Group |
Allows creating a sales group |
updateHousehold |
ZCM_UPDATE_SALES_GROUP_PRIV |
Update Sales Group |
Allows updating a sales group |
Privileges to Duty Roles Mapping
Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
---|---|---|---|
ZCM_UPDATE_SALES_GROUP_PRIV |
ORA_ZCM_SR_SALES_PARTY_MANAGEMENT |
Service Sales Party Management |
Can create Service Requests and help with resolution of the Service Request. Has basic Service Request management capabilities. |
ZCM_UPDATE_SALES_GROUP_PRIV |
ORA_ZCM_MKTG_SALES_PARTY_MANAGEMENT_DUTY |
Marketing Sales Party Management |
Manages creation and maintenance of the sales organizations and consumers for internal marketing users. Additional duties include viewing of appointments, interactions, and customer contacts. |
ZCM_UPDATE_SALES_GROUP_PRIV |
ORA_ZCM_PARTNER_SALES_PARTY_MANAGEMENT_DUTY |
Partner Sales Party Management |
Manages creation and maintenance of sales organizations and consumers for partners. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts. This role has limited access to customers and contacts. |
ZCM_UPDATE_SALES_GROUP_PRIV |
ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY |
Sales Party Management |
Manages creation and maintenance of the sales organizations and consumers for internal sales users. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts. |
ZCM_DELETE_SALES_GROUP_PRIV |
ORA_ZCM_SALES_PARTY_ADMINISTRATION_DUTY |
Sales Party Administration |
Manages named sales accounts, sales account import scheduler and the flagging of existing accounts. Additional duties include managing sales parties, functional setups, customer center objects, and relationship information inquiries. |
ZCM_CREATE_SALES_GROUP_PRIV |
ORA_ZCM_SR_SALES_PARTY_MANAGEMENT |
Service Sales Party Management |
Can create Service Requests and help with resolution of the Service Request. Has basic Service Request management capabilities. |
ZCM_CREATE_SALES_GROUP_PRIV |
ORA_ZCM_MKTG_SALES_PARTY_MANAGEMENT_DUTY |
Marketing Sales Party Management |
Manages creation and maintenance of the sales organizations and consumers for internal marketing users. Additional duties include viewing of appointments, interactions, and customer contacts. |
ZCM_CREATE_SALES_GROUP_PRIV |
ORA_ZCM_PARTNER_SALES_PARTY_MANAGEMENT_DUTY |
Partner Sales Party Management |
Manages creation and maintenance of sales organizations and consumers for partners. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts. This role has limited access to customers and contacts. |
ZCM_CREATE_SALES_GROUP_PRIV |
ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY |
Sales Party Management |
Manages creation and maintenance of the sales organizations and consumers for internal sales users. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts. |
ZCM_VIEW_SALES_GROUP_PRIV |
ORA_ZCM_SR_SALES_PARTY_MANAGEMENT |
Service Sales Party Management |
Can create Service Requests and help with resolution of the Service Request. Has basic Service Request management capabilities. |
ZCM_VIEW_SALES_GROUP_PRIV |
ORA_SVC_CASE_SUPERVISION |
Case Supervision |
Supervises and manages caseworkers, assists caseworkers with any complex issues, handles case approvals and escalations, coordinates care and benefits with external service providers, assigns or reassigns cases to caseworkers, conducts evaluations of benefits programs and provides feedback. |
ZCM_VIEW_SALES_GROUP_PRIV |
ORA_ZCM_MKTG_SALES_PARTY_MANAGEMENT_DUTY |
Marketing Sales Party Management |
Manages creation and maintenance of the sales organizations and consumers for internal marketing users. Additional duties include viewing of appointments, interactions, and customer contacts. |
ZCM_VIEW_SALES_GROUP_PRIV |
ORA_ZCM_SALES_PARTY_REVIEW_DUTY |
Sales Party Review |
Allows resources read-only access to sales parties information such as manage customer work area and all sales party duties. Additional duties include view access to other customer and sales lead features. |
ZCM_VIEW_SALES_GROUP_PRIV |
ORA_SVC_CASE_EXECUTION |
Case Execution |
Assists clients who are applying for benefits, opens cases and manages all tasks associated to the case, processes clients applications, evaluate clients needs for benefits, counsels benefits recipients, performs assessments of clients strengths and needs to develop benefit plans, performs follow-up with clients to ensure they are working on their tasks. |
ZCM_VIEW_SALES_GROUP_PRIV |
ORA_ZCM_PARTNER_SALES_PARTY_MANAGEMENT_DUTY |
Partner Sales Party Management |
Manages creation and maintenance of sales organizations and consumers for partners. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts. This role has limited access to customers and contacts. |
Duty Roles to Duty or Job Roles Mapping
Duty Role Code | Granted to Duty or Job Role Code | Granted to Duty or Job Role Name | Granted To Duty or Job Role Description |
---|---|---|---|
ORA_ZCM_SALES_PARTY_REVIEW_DUTY |
ORA_OKC_ALL_BUSINESS_UNITS_CONTRACT_INQUIRY_DUTY_CRM |
Contract View Access Across All Contracts |
Views all contracts across an enterprise. |
ORA_ZCM_MKTG_SALES_PARTY_MANAGEMENT_DUTY |
ORA_OKC_ALL_BUSINESS_UNITS_CONTRACT_INQUIRY_DUTY_CRM |
Contract View Access Across All Contracts |
Views all contracts across an enterprise. |
ORA_ZCM_SALES_PARTY_ADMINISTRATION_DUTY |
ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY |
Sales Party Management |
Manages creation and maintenance of the sales organizations and consumers for internal sales users. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts. |
ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY |
ORA_ZCM_SALES_PARTY_REVIEW_DUTY |
Sales Party Review |
Allows resources read-only access to sales parties information such as manage customer work area and all sales party duties. Additional duties include view access to other customer and sales lead features. |
ORA_ZCM_SALES_PARTY_ADMINISTRATION_DUTY |
ORA_DATA_QUALITY_ADMIN_DUTY |
Trading Community Data Quality Administration |
Configures, reviews, and edits predefined data quality server configurations and the predefined matching, synchronization, and cleansing configurations. |
ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY |
ORA_MANAGE_TRADING_COMMUNITY_IMPORT_BATCH_DUTY |
Trading Community Import Batch Management |
Manages trading community data import batches. |
ORA_ZCM_MKTG_SALES_PARTY_MANAGEMENT_DUTY |
ORA_MANAGE_TRADING_COMMUNITY_IMPORT_BATCH_DUTY |
Trading Community Import Batch Management |
Manages trading community data import batches. |
ORA_ZCM_SALES_PARTY_ADMINISTRATION_DUTY |
ORA_MANAGE_TRADING_COMMUNITY_IMPORT_BATCH_DUTY |
Trading Community Import Batch Management |
Manages trading community data import batches. |