1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Households
  4. Household Contact

Get all household contacts

get

/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/HouseholdContact

Request

Path Parameters
  • The unique primary identifier for the household party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a household contact with the specified primary key.
      Finder Variables:
      • RelationshipRecId; integer; The unique identifier of associated relationship to get the household contact.
    • RelationshipRecIdRF: Finds a household contact with specified relationship record identifier.
      Finder Variables:
      • RelationshipRecId; integer; The unique identifier of associated relationship to get the household contact.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ContactFirstName; string; The first name of the contact record.
    • ContactLastName; string; The last name of the contact record.
    • ContactLastUpdateDate; string; The date when the contact record was last updated.
    • ContactMiddleName; string; The middle name of the contact record.
    • ContactName; string; The name of the contact.
    • ContactPartyId; integer; The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
    • ContactPartyNumber; string; The public key identifier for the subject party of the relationship.
    • ContactSourceSystem; string; The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
    • ContactSourceSystemReferenceValue; string; The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
    • CreatedBy; string; The user who created the household contact member.
    • CreatedByModule; string; The application module that created the household contact record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
    • CreationDate; string; The date on which household contact record was created.
    • DateOfBirth; string; The date of birth of the associated contact.
    • EmailAddress; string; The email address email the associated contact.
    • EmailVerificationDate; string; The date of the verification for the email.
    • EmailVerificationStatus; string; The status of the verification for email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values aren't verified.
    • EndDate; string; The end date of the household contact record.
    • Gender; string; The gender of the associated contact.
    • HeadOfHouseholdFlag; boolean; The head of household flag the associated contact.
    • HouseholdIncome; number; The household income of the associated contact.
    • HouseholdPartyId; integer; The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
    • HouseholdPartyName; string; The name of the household.
    • HouseholdPartyNumber; string; The public unique identification number for the object party of the relationship.
    • HouseholdSize; number; The household size of the associated contact.
    • HouseholdSourceSystem; string; The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup.
    • HouseholdSourceSystemReferenceValue; string; The identifier for the object party in the relationship from external source system.
    • HouseholdUniqueName; string; The unique name of the household.
    • JobTitle; string; The job title of the associated contact.
    • LastUpdateDate; string; The last update date the household contact record.
    • LastUpdateLogin; string; The last update login the household contact record.
    • LastUpdatedBy; string; The last update by the household contact record.
    • MaritalStatus; string; The marital status of the household contact record.
    • PhoneVerificationDate; string; The date of the verification for phone.
    • PhoneVerificationStatus; string; The status of the verification for phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values aren't verified.
    • PreferredContactMethod; string; The preferred contact method contact the associated contact.
    • RelationshipCode; string; The code indicating whether this is a forward or a backward relationship code.
    • RelationshipId; integer; The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
    • RelationshipRecId; integer; The unique identifier of the household contact record.
    • RelationshipSourceSystem; string; The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
    • RelationshipSourceSystemReferenceValue; string; The identifier for the relationship with the external source system.
    • RelationshipType; string; The name of the type of the relationship. For example, HOUSEHOLD.
    • Salutation; string; The salutation of the associated contact.
    • StartDate; string; The start date of the household contact record.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : households-HouseholdContact
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : households-HouseholdContact-item-response
Type: object
Show Source
  • Title: First Name
    Maximum Length: 150
    The first name of the contact record.
  • Title: Last Name
    Maximum Length: 150
    The last name of the contact record.
  • Title: Last Updated Date
    Read Only: true
    The date when the contact record was last updated.
  • Title: Middle Name
    Maximum Length: 60
    The middle name of the contact record.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The name of the contact.
  • Title: Contact Party ID
    The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
  • Title: Contact Party Number
    Maximum Length: 30
    The public key identifier for the subject party of the relationship.
  • Title: Contact Source System
    The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
  • Title: Contact Source System Reference
    The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the household contact member.
  • Title: Created by Application
    Maximum Length: 30
    Default Value: HZ_WS
    The application module that created the household contact record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.
  • Title: Creation Date
    Read Only: true
    The date on which household contact record was created.
  • Title: Date of Birth
    The date of birth of the associated contact.
  • Title: OK to Call
    Read Only: true
    Maximum Length: 10
    Default Value: false
    Indicates whether you can email the household contact. The accepted values are True and False or Y and N. Default is False or N.
  • Title: OK to Email
    Read Only: true
    Maximum Length: 10
    Default Value: false
    Indicates whether you can email the household contact. The accepted values are True and False or Y and N. Default is False or N.
  • Title: Do Not Call
    Read Only: true
    Maximum Length: 255
    Default Value: false
    Indicates whether you can call the household contact. The accepted values are True and False or Y and N. Default is False or N.
  • Title: Do Not Email
    Read Only: true
    Maximum Length: 255
    Default Value: false
    Indicates whether you can email the household contact. The accepted values are True and False or Y and N. Default is False or N.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email address email the associated contact.
  • Title: Verification Date
    Read Only: true
    The date of the verification for the email.
  • Title: Verification Status
    Read Only: true
    Maximum Length: 30
    The status of the verification for email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values aren't verified.
  • Title: To Date
    The end date of the household contact record.
  • Title: Address
    Read Only: true
    The formatted address of the contact.
  • Title: Phone Number
    Read Only: true
    The primary formatted phone number for the contact person.
  • Title: Gender
    Maximum Length: 30
    The gender of the associated contact.
  • Title: Head of Household Indicator
    Maximum Length: 1
    The head of household flag the associated contact.
  • Title: Household Income
    The household income of the associated contact.
  • Title: Household Party ID
    The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship.
  • Title: Household
    Read Only: true
    Maximum Length: 360
    The name of the household.
  • Title: Household Party Number
    Maximum Length: 30
    The public unique identification number for the object party of the relationship.
  • Title: Household Size
    The household size of the associated contact.
  • Title: Related Household Source System
    The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup.
  • Title: Related Household Source System Reference
    The identifier for the object party in the relationship from external source system.
  • Title: Household
    Read Only: true
    Maximum Length: 900
    The unique name of the household.
  • Title: Job Title
    Maximum Length: 100
    The job title of the associated contact.
  • Title: Last Updated Date
    Read Only: true
    The last update date the household contact record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The last update by the household contact record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The last update login the household contact record.
  • Links
  • Title: Marital Status
    Maximum Length: 30
    The marital status of the household contact record.
  • Title: Verification Date
    Read Only: true
    The date of the verification for phone.
  • Title: Verification Status
    Read Only: true
    Maximum Length: 30
    The status of the verification for phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values aren't verified.
  • Title: Preferred Contact
    Maximum Length: 10
    Default Value: false
    Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.
  • Title: Preferred Contact Method
    Maximum Length: 30
    The preferred contact method contact the associated contact.
  • Title: Relationship Code
    Maximum Length: 30
    Default Value: ORA_PARENT_IN
    The code indicating whether this is a forward or a backward relationship code.
  • Title: Relationship ID
    Read Only: true
    The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
  • Title: Relationship Record ID
    The unique identifier of the household contact record.
  • Title: Relationship Source System
    The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems.
  • Title: Relationship Source System Reference
    The identifier for the relationship with the external source system.
  • Title: Relationship Type
    Maximum Length: 30
    Default Value: HOUSEHOLD
    The name of the type of the relationship. For example, HOUSEHOLD.
  • Title: Role
    The role of the relationship.
  • Title: Salutation
    Maximum Length: 60
    The salutation of the associated contact.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • Title: From Date
    The start date of the household contact record.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : households-HouseholdContact-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : households-HouseholdContact-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : households-HouseholdContact-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : households-HouseholdContact-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Back to Top

Examples

The following example shows how to get all household contacts by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/HouseholdContact

Example of Response Body

The following shows an example of the response body in JSON format.

For add action intent

{
    "items": [
        {
            "RelationshipRecId": 300100036239574,
            "RelationshipId": 300100036239575,
            "RelationshipSourceSystem": null,
            "RelationshipSourceSystemReferenceValue": null,
            "HouseholdPartyId": 300100036239559,
            "HouseholdPartyName": "HH_Test100",
            "HouseholdPartyNumber": "CDRM_74691",
            "HouseholdUniqueName": "HH_Test100 (SUNNYVALE, US)",
            "HouseholdSourceSystem": null,
            "HouseholdSourceSystemReferenceValue": null,
            "ContactPartyId": 300100036239567,
            "ContactPartyNumber": "CDRM_74692",
            "ContactSourceSystem": null,
            "ContactSourceSystemReferenceValue": null,
            "ContactName": "HH_Test100_FN dedd HH_Test100_LN ff",
            "ContactFirstName": "HH_Test100_FN",
            "ContactLastName": "HH_Test100_LN",
            "ContactMiddleName": "dedd",
            "Salutation": "ffg",
            "PreferredContactFlag": false,
            "DateOfBirth": "2014-07-03",
            "Gender": "FEMALE",
            "MaritalStatus": "N",
            "HeadOfHouseholdFlag": null,
            "HouseholdIncome": null,
            "HouseholdSize": null,
            "PreferredContactMethod": "PHONE",
            "JobTitle": null,
            "FormattedPhoneNumber": "+1 (22)22 x22",
            "DoNotCallFlag": true,
            "DoCallFlag": false,
            "PhoneVerificationStatus": null,
            "PhoneVerificationDate": null,
            "EmailAddress": "sendmail-test-discard@oracle.com",
            "DoNotEmailFlag": false,
            "DoEmailFlag": false,
            "EmailVerificationStatus": null,
            "EmailVerificationDate": null,
            "FormattedAddress": "100 ORACLE PKWY,REDWOOD CITY, CA 94065",
            "RelationshipType": "HOUSEHOLD",
            "RelationshipCode": "ORA_SPOUSE_IN",
            "Role": "SPOUSE",
            "StartDate": "2014-07-22",
            "EndDate": "4712-12-31",
            "CreatedByModule": "ZCM",
            "LastUpdateDate": "2014-07-22T01:58:13.078+00:00",
            "LastUpdatedBy": "SALES_ADMIN",
            "LastUpdateLogin": "FEC1F045C60E2F42E0435060F00AD336",
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2014-07-22T01:58:11.530+00:00",
            "ContactLastUpdateDate": "2014-07-22T02:20:30.140+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/resources/11.13.18.05/households/CDRM_74691/child/HouseholdContact/300100036239574",
                    "name": "HouseholdContact",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E00020000000478"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/resources/11.13.18.05/households/CDRM_74691/child/HouseholdContact/300100036239574",
                    "name": "HouseholdContact",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/resources/11.13.18.05/households/CDRM_74691",
                    "name": "households",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/resources/11.13.18.05/households/CDRM_74691/child/HouseholdContact/300100036239574/lov/RoleLOV",
                    "name": "RoleLOV",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/resources/11.13.18.05/households/CDRM_74691/child/HouseholdContact/300100036239574/child/smartActions",
                    "name": "smartActions",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com:443/crmRestApi/resources/11.13.18.05/households/CDRM_74691/child/HouseholdContact",
            "name": "HouseholdContact",
            "kind": "collection"
        }
    ]
}
Back to Top