Jump to

• Request
• Response

Update a household contact

patch

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

Request

Path Parameters

• PartyNumber(required): string
  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.
• RelationshipRecId(required): integer(int64)
  The unique identifier of the household contact record.

Header Parameters

• Metadata-Context: string
  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".
• REST-Framework-Version: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ContactFirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of the contact record.
• ContactLastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of the contact record.
• ContactMiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of the contact record.
• ContactPartyNumber: string
  Title: Contact Party Number

  Maximum Length: 30

  The public key identifier for the subject party of the relationship.
• ContactSourceSystem: string
  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.
• ContactSourceSystemReferenceValue: string
  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.
• DateOfBirth: string (date)
  Title: Date of Birth

  The date of birth of the associated contact.
• EndDate: string (date)
  Title: To Date

  The end date of the household contact record.
• Gender: string
  Title: Gender

  Maximum Length: 30

  The gender of the associated contact.
• HeadOfHouseholdFlag: boolean
  Title: Head of Household Indicator

  Maximum Length: 1

  The head of household flag the associated contact.
• HouseholdIncome: number
  Title: Household Income

  The household income of the associated contact.
• HouseholdPartyId: integer (int64)
  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.
• HouseholdPartyNumber: string
  Title: Household Party Number

  Maximum Length: 30

  The public unique identification number for the object party of the relationship.
• HouseholdSize: number
  Title: Household Size

  The household size of the associated contact.
• HouseholdSourceSystem: string
  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.
• HouseholdSourceSystemReferenceValue: string
  Title: Related Household Source System Reference

  The identifier for the object party in the relationship from external source system.
• JobTitle: string
  Title: Job Title

  Maximum Length: 100

  The job title of the associated contact.
• MaritalStatus: string
  Title: Marital Status

  Maximum Length: 30

  The marital status of the household contact record.
• PreferredContactFlag: boolean
  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.
• PreferredContactMethod: string
  Title: Preferred Contact Method

  Maximum Length: 30

  The preferred contact method contact the associated contact.
• RelationshipSourceSystem: string
  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.
• RelationshipSourceSystemReferenceValue: string
  Title: Relationship Source System Reference

  The identifier for the relationship with the external source system.
• Salutation: string
  Title: Salutation

  Maximum Length: 60

  The salutation of the associated contact.
• smartActions: array Smart Actions
  Title: Smart Actions

  This VO stores the endpoint and security details for every user action.
• StartDate: string (date)
  Title: From Date

  The start date of the household contact record.

{
    "type":"object",
    "properties":{
        "HouseholdIncome":{
            "title":"Household Income",
            "type":"number",
            "description":"The household income of the associated contact.",
            "nullable":true
        },
        "HouseholdSize":{
            "title":"Household Size",
            "type":"number",
            "description":"The household size of the associated contact.",
            "nullable":true
        },
        "Gender":{
            "title":"Gender",
            "maxLength":30,
            "type":"string",
            "description":"The gender of the associated contact.",
            "nullable":true
        },
        "Salutation":{
            "title":"Salutation",
            "maxLength":60,
            "type":"string",
            "description":"The salutation of the associated contact.",
            "nullable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the associated contact.",
            "nullable":true
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"This VO stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/households-HouseholdContact-smartActions-item-patch-request"
            }
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The start date of the household contact record.",
            "format":"date",
            "nullable":false
        },
        "HouseholdPartyNumber":{
            "title":"Household Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identification number for the object party of the relationship.",
            "nullable":false
        },
        "PreferredContactFlag":{
            "title":"Preferred Contact",
            "maxLength":10,
            "type":"boolean",
            "description":"Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PreferredContactPersonId"
                ]
            }
        },
        "ContactFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the contact record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            }
        },
        "PreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":30,
            "type":"string",
            "description":"The preferred contact method contact the associated contact.",
            "nullable":true
        },
        "DateOfBirth":{
            "title":"Date of Birth",
            "type":"string",
            "description":"The date of birth of the associated contact.",
            "format":"date",
            "nullable":true
        },
        "HouseholdPartyId":{
            "title":"Household Party ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContactMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the contact record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            }
        },
        "ContactSourceSystem":{
            "title":"Contact Source System",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            }
        },
        "RelationshipSourceSystemReferenceValue":{
            "title":"Relationship Source System Reference",
            "type":"string",
            "description":"The identifier for the relationship with the external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            }
        },
        "ContactSourceSystemReferenceValue":{
            "title":"Contact Source System Reference",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            }
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The end date of the household contact record.",
            "format":"date",
            "nullable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The public key identifier for the subject party of the relationship.",
            "nullable":false
        },
        "ContactLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the contact record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            }
        },
        "RelationshipSourceSystem":{
            "title":"Relationship Source System",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            }
        },
        "HouseholdSourceSystem":{
            "title":"Related Household Source System",
            "type":"string",
            "description":"The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "HouseholdSourceSystemStr"
                ]
            }
        },
        "MaritalStatus":{
            "title":"Marital Status",
            "maxLength":30,
            "type":"string",
            "description":"The marital status of the household contact record.",
            "nullable":true
        },
        "HeadOfHouseholdFlag":{
            "title":"Head of Household Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The head of household flag the associated contact.",
            "nullable":true
        },
        "HouseholdSourceSystemReferenceValue":{
            "title":"Related Household Source System Reference",
            "type":"string",
            "description":"The identifier for the object party in the relationship from external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "HouseholdSourceSystemStr"
                ]
            }
        }
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

This VO stores the endpoint and security details for every user action.

Show Source

• Array of: object households-HouseholdContact-smartActions-item-patch-request

{
    "title":"Smart Actions",
    "type":"array",
    "description":"This VO stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/households-HouseholdContact-smartActions-item-patch-request"
    }
}

Nested Schema : households-HouseholdContact-smartActions-item-patch-request

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message to seek confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  Consumer-friendly action name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  REST Resources the action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The REST endpoint to perform the action.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  List of applications that this action can be used in.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Boolean type indicating if this action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  HTTP method to use with HREF.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates if smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Boolean type indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  Attributes to be updated when the Actions UI is launched.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  Number to indicate priority of the action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  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.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/households-HouseholdContact-smartActions-UserActionURLBinding-item-patch-request"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/households-HouseholdContact-smartActions-UserActionNavigation-item-patch-request"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/households-HouseholdContact-smartActions-UserActionRequestPayload-item-patch-request"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true
        }
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object households-HouseholdContact-smartActions-UserActionNavigation-item-patch-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/households-HouseholdContact-smartActions-UserActionNavigation-item-patch-request"
    }
}

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

• Array of: object households-HouseholdContact-smartActions-UserActionRequestPayload-item-patch-request

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/households-HouseholdContact-smartActions-UserActionRequestPayload-item-patch-request"
    }
}

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

• Array of: object households-HouseholdContact-smartActions-UserActionURLBinding-item-patch-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/households-HouseholdContact-smartActions-UserActionURLBinding-item-patch-request"
    }
}

Nested Schema : households-HouseholdContact-smartActions-UserActionNavigation-item-patch-request

Type: object

Show Source

• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value indicating if the action is seeded or custom.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  Application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  Metadata of the navigation as needed for the specific usage.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"Application usage.",
            "nullable":false
        }
    }
}

Nested Schema : households-HouseholdContact-smartActions-UserActionRequestPayload-item-patch-request

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the binding type of the value.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Boolean value indicating if the payload is mandatory.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The key in the Key Value pair that forms the payload.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value in the Key Value pair that forms the payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":true
        }
    }
}

Nested Schema : households-HouseholdContact-smartActions-UserActionURLBinding-item-patch-request

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  This is a hint for processing the Url Binding runtime.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean indicator.
• URLBindingName: string
  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.
• Value: string
  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.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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-item-response

Type: object

Show Source

• ContactFirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of the contact record.
• ContactLastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of the contact record.
• ContactLastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the contact record was last updated.
• ContactMiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of the contact record.
• ContactName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the contact.
• ContactPartyId: integer (int64)
  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.
• ContactPartyNumber: string
  Title: Contact Party Number

  Maximum Length: 30

  The public key identifier for the subject party of the relationship.
• ContactSourceSystem: string
  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.
• ContactSourceSystemReferenceValue: string
  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.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the household contact member.
• CreatedByModule: string
  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.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date on which household contact record was created.
• DateOfBirth: string (date)
  Title: Date of Birth

  The date of birth of the associated contact.
• DoCallFlag: boolean
  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.
• DoEmailFlag: boolean
  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.
• DoNotCallFlag: boolean
  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.
• DoNotEmailFlag: boolean
  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.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address email the associated contact.
• EmailVerificationDate: string (date)
  Title: Verification Date

  Read Only: true

  The date of the verification for the email.
• EmailVerificationStatus: string
  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.
• EndDate: string (date)
  Title: To Date

  The end date of the household contact record.
• FormattedAddress: string
  Title: Address

  Read Only: true

  The formatted address of the contact.
• FormattedPhoneNumber: string
  Title: Phone Number

  Read Only: true

  The primary formatted phone number for the contact person.
• Gender: string
  Title: Gender

  Maximum Length: 30

  The gender of the associated contact.
• HeadOfHouseholdFlag: boolean
  Title: Head of Household Indicator

  Maximum Length: 1

  The head of household flag the associated contact.
• HouseholdIncome: number
  Title: Household Income

  The household income of the associated contact.
• HouseholdPartyId: integer (int64)
  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.
• HouseholdPartyName: string
  Title: Household

  Read Only: true

  Maximum Length: 360

  The name of the household.
• HouseholdPartyNumber: string
  Title: Household Party Number

  Maximum Length: 30

  The public unique identification number for the object party of the relationship.
• HouseholdSize: number
  Title: Household Size

  The household size of the associated contact.
• HouseholdSourceSystem: string
  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.
• HouseholdSourceSystemReferenceValue: string
  Title: Related Household Source System Reference

  The identifier for the object party in the relationship from external source system.
• HouseholdUniqueName: string
  Title: Household

  Read Only: true

  Maximum Length: 900

  The unique name of the household.
• JobTitle: string
  Title: Job Title

  Maximum Length: 100

  The job title of the associated contact.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The last update date the household contact record.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The last update by the household contact record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The last update login the household contact record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaritalStatus: string
  Title: Marital Status

  Maximum Length: 30

  The marital status of the household contact record.
• PhoneVerificationDate: string (date)
  Title: Verification Date

  Read Only: true

  The date of the verification for phone.
• PhoneVerificationStatus: string
  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.
• PreferredContactFlag: boolean
  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.
• PreferredContactMethod: string
  Title: Preferred Contact Method

  Maximum Length: 30

  The preferred contact method contact the associated contact.
• RelationshipCode: string
  Title: Relationship Code

  Maximum Length: 30

  Default Value: ORA_PARENT_IN

  The code indicating whether this is a forward or a backward relationship code.
• RelationshipId: integer (int64)
  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.
• RelationshipRecId: integer (int64)
  Title: Relationship Record ID

  The unique identifier of the household contact record.
• RelationshipSourceSystem: string
  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.
• RelationshipSourceSystemReferenceValue: string
  Title: Relationship Source System Reference

  The identifier for the relationship with the external source system.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 30

  Default Value: HOUSEHOLD

  The name of the type of the relationship. For example, HOUSEHOLD.
• Role: string
  Title: Role

  The role of the relationship.
• Salutation: string
  Title: Salutation

  Maximum Length: 60

  The salutation of the associated contact.
• smartActions: array Smart Actions
  Title: Smart Actions

  This VO stores the endpoint and security details for every user action.
• StartDate: string (date)
  Title: From Date

  The start date of the household contact record.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which household contact record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"The name of the type of the relationship. For example, HOUSEHOLD.",
            "nullable":false,
            "default":"HOUSEHOLD",
            "x-queryable":true
        },
        "Gender":{
            "title":"Gender",
            "maxLength":30,
            "type":"string",
            "description":"The gender of the associated contact.",
            "nullable":true,
            "x-queryable":true
        },
        "DoCallFlag":{
            "title":"OK to Call",
            "maxLength":10,
            "type":"boolean",
            "description":"Indicates whether you can email the household contact. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"This VO stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/households-HouseholdContact-smartActions-item-response"
            }
        },
        "StartDate":{
            "title":"From Date",
            "type":"string",
            "description":"The start date of the household contact record.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PreferredContactFlag":{
            "title":"Preferred Contact",
            "maxLength":10,
            "type":"boolean",
            "description":"Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PreferredContactPersonId"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone Number",
            "type":"string",
            "description":"The primary formatted phone number for the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailVerificationStatus":{
            "title":"Verification Status",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":true
        },
        "PreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":30,
            "type":"string",
            "description":"The preferred contact method contact the associated contact.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The last update by the household contact record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateOfBirth":{
            "title":"Date of Birth",
            "type":"string",
            "description":"The date of birth of the associated contact.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "HouseholdUniqueName":{
            "title":"Household",
            "maxLength":900,
            "type":"string",
            "description":"The unique name of the household.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the household contact member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactLastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the contact record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactSourceSystem":{
            "title":"Contact Source System",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RelationshipRecId":{
            "title":"Relationship Record ID",
            "type":"integer",
            "description":"The unique identifier of the household contact record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address email the associated contact.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PhoneVerificationStatus":{
            "title":"Verification Status",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The public key identifier for the subject party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the contact record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "Role":{
            "title":"Role",
            "type":"string",
            "description":"The role of the relationship.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelationshipSourceSystem":{
            "title":"Relationship Source System",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "MaritalStatus":{
            "title":"Marital Status",
            "maxLength":30,
            "type":"string",
            "description":"The marital status of the household contact record.",
            "nullable":true,
            "x-queryable":true
        },
        "HeadOfHouseholdFlag":{
            "title":"Head of Household Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The head of household flag the associated contact.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailVerificationDate":{
            "title":"Verification Date",
            "type":"string",
            "description":"The date of the verification for the email.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The last update login the household contact record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HouseholdPartyName":{
            "title":"Household",
            "maxLength":360,
            "type":"string",
            "description":"The name of the household.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HouseholdIncome":{
            "title":"Household Income",
            "type":"number",
            "description":"The household income of the associated contact.",
            "nullable":true,
            "x-queryable":true
        },
        "HouseholdSize":{
            "title":"Household Size",
            "type":"number",
            "description":"The household size of the associated contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Salutation":{
            "title":"Salutation",
            "maxLength":60,
            "type":"string",
            "description":"The salutation of the associated contact.",
            "nullable":true,
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the associated contact.",
            "nullable":true,
            "x-queryable":true
        },
        "HouseholdPartyNumber":{
            "title":"Household Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identification number for the object party of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "DoNotCallFlag":{
            "title":"Do Not Call",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether you can call the household contact. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating whether this is a forward or a backward relationship code.",
            "nullable":false,
            "default":"ORA_PARENT_IN",
            "x-queryable":true
        },
        "DoEmailFlag":{
            "title":"OK to Email",
            "maxLength":10,
            "type":"boolean",
            "description":"Indicates whether you can email the household contact. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "ContactFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the contact record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "HouseholdPartyId":{
            "title":"Household Party ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the contact record.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            },
            "x-queryable":true
        },
        "RelationshipSourceSystemReferenceValue":{
            "title":"Relationship Source System Reference",
            "type":"string",
            "description":"The identifier for the relationship with the external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RelationshipSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "ContactSourceSystemReferenceValue":{
            "title":"Contact Source System Reference",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContactSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The end date of the household contact record.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "HouseholdSourceSystem":{
            "title":"Related Household Source System",
            "type":"string",
            "description":"The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "HouseholdSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "RelationshipId":{
            "title":"Relationship ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HouseholdSourceSystemReferenceValue":{
            "title":"Related Household Source System Reference",
            "type":"string",
            "description":"The identifier for the object party in the relationship from external source system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "HouseholdSourceSystemStr"
                ]
            },
            "x-queryable":true
        },
        "DoNotEmailFlag":{
            "title":"Do Not Email",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether you can email the household contact. The accepted values are True and False or Y and N. Default is False or N.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "PhoneVerificationDate":{
            "title":"Verification Date",
            "type":"string",
            "description":"The date of the verification for phone.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The last update date the household contact record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

This VO stores the endpoint and security details for every user action.

Show Source

• Array of: object households-HouseholdContact-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"This VO stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/households-HouseholdContact-smartActions-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : households-HouseholdContact-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message to seek confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  Consumer-friendly action name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  REST Resources the action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The REST endpoint to perform the action.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  List of applications that this action can be used in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Boolean type indicating if this action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  HTTP method to use with HREF.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates if smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Boolean type indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  Attributes to be updated when the Actions UI is launched.
• UserActionId: integer (int64)
  Title: User Action ID

  Uniquely identifies the action. For internal use.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  Uniquely identifies the action with a name. For internal use.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  Number to indicate priority of the action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  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.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/households-HouseholdContact-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/households-HouseholdContact-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Uniquely identifies the action with a name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"Uniquely identifies the action. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/households-HouseholdContact-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object households-HouseholdContact-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/households-HouseholdContact-smartActions-UserActionNavigation-item-response"
    }
}

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

• Array of: object households-HouseholdContact-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/households-HouseholdContact-smartActions-UserActionRequestPayload-item-response"
    }
}

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

• Array of: object households-HouseholdContact-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/households-HouseholdContact-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : households-HouseholdContact-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value indicating if the action is seeded or custom.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  Application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  Metadata of the navigation as needed for the specific usage.
• UserActionNavId: integer (int64)
  Title: Primary Key

  Primary key for the user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"Primary key for the user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"Application usage.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : households-HouseholdContact-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the binding type of the value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Boolean value indicating if the payload is mandatory.
• RequestPayloadId: integer (int64)
  Uniquely identifies the payload for smart actions. For internal use.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The key in the Key Value pair that forms the payload.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value in the Key Value pair that forms the payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"Uniquely identifies the payload for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : households-HouseholdContact-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  This is a hint for processing the Url Binding runtime.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean indicator.
• URLBindingId: integer (int64)
  Uniquely identifies the URL Bind for smart actions. For internal use.
• URLBindingName: string
  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.
• Value: string
  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.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"Uniquely identifies the URL Bind for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

RoleLOV

Operation: /crmRestApi/resources/11.13.18.05/relationshipTypes

Parameters:

• finder: RoleForSubjectObjectFinder%3BbindObjectType%3DGROUP%2CbindRelationshipGroup%3DORA_HOUSEHOLD_CONTACT_GROUP%2CbindSubjectType%3DPERSON

The list of values indicating the roles played by a contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.

The following properties are defined on the LOV link relation:

• Source Attribute: Role; Target Attribute: Role
• Display Attribute: Description

smartActions

Operation: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/HouseholdContact/{RelationshipRecId}/child/smartActions

Parameters:

• PartyNumber: $request.path.PartyNumber
• RelationshipRecId: $request.path.RelationshipRecId

This VO stores the endpoint and security details for every user action.

Back to Top