Jump to

• Request
• Response

Create a contact point

post

/crmRestApi/resources/11.13.18.05/partnerContacts/{PartyNumber}/child/contactPoints

Request

Path Parameters

• PartyNumber(required): string
  The unique identifier for the partner contact party. It Can be system-generated or user-provided during create, based on the profile option HZ_GENERATE_PARTY_NUMBER.

Header Parameters

• 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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The unique identifier of the conflict. Note: This is an internal attribute and should not be used.
• ContactPointType: string
  Title: Type

  Maximum Length: 30

  The type of the contact point such as EMAIL or PHONE.
• CreatedByModule: string
  Title: Created by Application

  Default Value: HZ_WS

  The module that created the contact point record.
• DoContactPreferenceFlag: boolean
  Title: OK to Contact

  Indicates whether to use a particular contact method. Defaulted to false.
• DoNotContactPreferenceFlag: boolean
  Title: Do Not Contact

  Indicates whether the contact point is not preferred for contact.
• DoNotContactReason: string
  Title: Do Not Contact Reason

  Indicates the reason for "Do Not Contact" preference.
• EmailAddress: string
  Title: Email

  Maximum Length: 255

  The e-mail address in the contact point.
• EmailPurpose: string
  Title: Email Purpose

  Maximum Length: 30

  The e-mail purpose for the email address in the contact point. For example: "BUSINESS" determines the purpose of the e-mail address.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The object version number. (This is an internal attribute and should not be used)
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party of the partner company.
• PartyNumber: string
  Title: Registry ID

  The party number of the partner company.
• PartySourceSystem: string
  Title: Party Source System

  The name of the external source system.
• PartySourceSystemReferenceValue: string
  Title: Party Source System Reference Value

  The identifier of the record from external source system.
• PhoneAreaCode: string
  Title: Area Code

  Maximum Length: 255

  The area code of the phone number in the contact point.
• PhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 255

  The phone country code of the phone number in the contact point.
• PhoneExtension: string
  Title: Extension

  Maximum Length: 255

  The phone extension of the phone number in the contact point.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 255

  The phone number in the contact point.
• PhonePurpose: string
  Title: Phone Purpose

  Maximum Length: 30

  The purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
• PhoneType: string
  Title: Type

  The type of the phone number in the contact point. For example: "FAX" or "WORK" determines the type of the phone number.
• PreferenceRequestedBy: string
  Title: Preference Requested By

  The list of values indicating the preference requested.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether the contact point is primary.
• RawPhoneNumber: string
  Title: Phone

  Maximum Length: 255

  The raw phone number in the contact point.
• SocialNetworkId: string
  Title: User ID

  The social network identifier. Note: This is an internal attribute and should not be used.
• SocialNetworkName: string
  Title: Social Network

  The social network name. Note: This is an internal attribute and should not be used.
• SocialNetworkPurpose: string
  Title: Social Network Purpose

  Maximum Length: 30

  Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS, and so on.
• SourceSystem: string
  Title: Source System

  The name of the external source system.
• SourceSystemReferenceValue: string
  Title: Source System Reference Value

  The identifier of the record from external source system.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: A

  The status of the contact point.
• URL: string
  Title: URL

  The URL in the contact point.
• VerificationDate: string (date)
  Title: Verification Date

  The date of verification of the phone or email contact point.
• VerificationStatus: string
  Title: Verification Status

  Maximum Length: 30

  The list of values indicating the purpose of the social network.
• WebPurpose: string
  Title: Web Purpose

  Maximum Length: 30

  The purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE, SALESURL, MARKETINGURL, SUPPORTURL, RSS_FEED and so on.

{
    "type":"object",
    "properties":{
        "VerificationStatus":{
            "title":"Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The list of values indicating the purpose of the social network.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VerificationDate":{
            "title":"Verification Date",
            "type":"string",
            "description":"The date of verification of the phone or email contact point.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VerificationStatus"
                ]
            }
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the contact point is primary.",
            "nullable":true,
            "default":false
        },
        "SocialNetworkId":{
            "title":"User ID",
            "type":"string",
            "description":"The social network identifier. Note: This is an internal attribute and should not be used.",
            "nullable":true,
            "x-hints":{
                "Property":"Social Network Account"
            }
        },
        "URL":{
            "title":"URL",
            "type":"string",
            "description":"The URL in the contact point.",
            "nullable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The unique identifier of the conflict. Note: This is an internal attribute and should not be used.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The identifier of the record from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"255",
            "type":"string",
            "description":"The area code of the phone number in the contact point.",
            "nullable":true
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"255",
            "type":"string",
            "description":"The phone country code of the phone number in the contact point.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number. (This is an internal attribute and should not be used)",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "type":"string",
            "description":"The module that created the contact point record.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the contact point.",
            "nullable":false,
            "default":"A"
        },
        "SocialNetworkPurpose":{
            "title":"Social Network Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The name of the external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "DoNotContactReason":{
            "title":"Do Not Contact Reason",
            "type":"string",
            "description":"Indicates the reason for \"Do Not Contact\" preference.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhonePurpose":{
            "title":"Phone Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PreferenceRequestedBy":{
            "title":"Preference Requested By",
            "type":"string",
            "description":"The list of values indicating the preference requested.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DoContactPreferenceFlag":{
            "title":"OK to Contact",
            "type":"boolean",
            "description":"Indicates whether to use a particular contact method. Defaulted to false.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"255",
            "type":"string",
            "description":"The e-mail address in the contact point.",
            "nullable":true
        },
        "SourceSystemReferenceValue":{
            "title":"Source System Reference Value",
            "type":"string",
            "description":"The identifier of the record from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneExtension":{
            "title":"Extension",
            "maxLength":"255",
            "type":"string",
            "description":"The phone extension of the phone number in the contact point.",
            "nullable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "type":"string",
            "description":"The party number of the partner company.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party of the partner company.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PhoneType":{
            "title":"Type",
            "type":"string",
            "description":"The type of the phone number in the contact point. For example: \"FAX\" or \"WORK\" determines the type of the phone number.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DoNotContactPreferenceFlag":{
            "title":"Do Not Contact",
            "type":"boolean",
            "description":"Indicates whether the contact point is not preferred for contact.",
            "nullable":true,
            "x-queryable":false
        },
        "WebPurpose":{
            "title":"Web Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE, SALESURL, MARKETINGURL, SUPPORTURL, RSS_FEED and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EmailPurpose":{
            "title":"Email Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The e-mail purpose for the email address in the contact point. For example: \"BUSINESS\" determines the purpose of the e-mail address.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"255",
            "type":"string",
            "description":"The phone number in the contact point.",
            "nullable":true
        },
        "SocialNetworkName":{
            "title":"Social Network",
            "type":"string",
            "description":"The social network name. Note: This is an internal attribute and should not be used.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "Property":"Social Network"
            }
        },
        "ContactPointType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the contact point such as EMAIL or PHONE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RawPhoneNumber":{
            "title":"Phone",
            "maxLength":"255",
            "type":"string",
            "description":"The raw phone number in the contact point.",
            "nullable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "type":"string",
            "description":"The name of the external source system.",
            "nullable":true,
            "x-queryable":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 : partnerContacts-contactPoints-item-response

Type: object

Show Source

• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The unique identifier of the conflict. Note: This is an internal attribute and should not be used.
• ContactPointId: integer (int64)
  Title: Contact Point ID

  Read Only: true

  The unique identifier of the contact point.
• ContactPointType: string
  Title: Type

  Maximum Length: 30

  The type of the contact point such as EMAIL or PHONE.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the contact point record.
• CreatedByModule: string
  Title: Created by Application

  Default Value: HZ_WS

  The module that created the contact point record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the contact point record was created.
• DoContactPreferenceFlag: boolean
  Title: OK to Contact

  Indicates whether to use a particular contact method. Defaulted to false.
• DoNotContactPreferenceFlag: boolean
  Title: Do Not Contact

  Indicates whether the contact point is not preferred for contact.
• DoNotContactReason: string
  Title: Do Not Contact Reason

  Indicates the reason for "Do Not Contact" preference.
• EmailAddress: string
  Title: Email

  Maximum Length: 255

  The e-mail address in the contact point.
• EmailPurpose: string
  Title: Email Purpose

  Maximum Length: 30

  The e-mail purpose for the email address in the contact point. For example: "BUSINESS" determines the purpose of the e-mail address.
• FormattedPhoneNumber: string
  Title: Phone Number

  Read Only: true

  Maximum Length: 255

  The formatted phone number in the contact point.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the contact point record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the contact point record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the contact point record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  The object version number. (This is an internal attribute and should not be used)
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the party of the partner company.
• PartyNumber: string
  Title: Registry ID

  The party number of the partner company.
• PartySourceSystem: string
  Title: Party Source System

  The name of the external source system.
• PartySourceSystemReferenceValue: string
  Title: Party Source System Reference Value

  The identifier of the record from external source system.
• PhoneAreaCode: string
  Title: Area Code

  Maximum Length: 255

  The area code of the phone number in the contact point.
• PhoneCountryCode: string
  Title: Phone Country Code

  Maximum Length: 255

  The phone country code of the phone number in the contact point.
• PhoneExtension: string
  Title: Extension

  Maximum Length: 255

  The phone extension of the phone number in the contact point.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 255

  The phone number in the contact point.
• PhonePurpose: string
  Title: Phone Purpose

  Maximum Length: 30

  The purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.
• PhoneType: string
  Title: Type

  The type of the phone number in the contact point. For example: "FAX" or "WORK" determines the type of the phone number.
• PreferenceRequestedBy: string
  Title: Preference Requested By

  The list of values indicating the preference requested.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Default Value: false

  Indicates whether the contact point is primary.
• RawPhoneNumber: string
  Title: Phone

  Maximum Length: 255

  The raw phone number in the contact point.
• SocialNetworkId: string
  Title: User ID

  The social network identifier. Note: This is an internal attribute and should not be used.
• SocialNetworkName: string
  Title: Social Network

  The social network name. Note: This is an internal attribute and should not be used.
• SocialNetworkPurpose: string
  Title: Social Network Purpose

  Maximum Length: 30

  Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS, and so on.
• SourceSystem: string
  Title: Source System

  The name of the external source system.
• SourceSystemReferenceValue: string
  Title: Source System Reference Value

  The identifier of the record from external source system.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: A

  The status of the contact point.
• URL: string
  Title: URL

  The URL in the contact point.
• VerificationDate: string (date)
  Title: Verification Date

  The date of verification of the phone or email contact point.
• VerificationStatus: string
  Title: Verification Status

  Maximum Length: 30

  The list of values indicating the purpose of the social network.
• WebPurpose: string
  Title: Web Purpose

  Maximum Length: 30

  The purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE, SALESURL, MARKETINGURL, SUPPORTURL, RSS_FEED and so on.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the contact point record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VerificationStatus":{
            "title":"Verification Status",
            "maxLength":"30",
            "type":"string",
            "description":"The list of values indicating the purpose of the social network.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VerificationDate":{
            "title":"Verification Date",
            "type":"string",
            "description":"The date of verification of the phone or email contact point.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VerificationStatus"
                ]
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the contact point is primary.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SocialNetworkId":{
            "title":"User ID",
            "type":"string",
            "description":"The social network identifier. Note: This is an internal attribute and should not be used.",
            "nullable":true,
            "x-hints":{
                "Property":"Social Network Account"
            },
            "x-queryable":true
        },
        "URL":{
            "title":"URL",
            "type":"string",
            "description":"The URL in the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The unique identifier of the conflict. Note: This is an internal attribute and should not be used.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"The identifier of the record from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneAreaCode":{
            "title":"Area Code",
            "maxLength":"255",
            "type":"string",
            "description":"The area code of the phone number in the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":"255",
            "type":"string",
            "description":"The phone country code of the phone number in the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The object version number. (This is an internal attribute and should not be used)",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ContactPointId":{
            "title":"Contact Point ID",
            "type":"integer",
            "description":"The unique identifier of the contact point.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone Number",
            "maxLength":"255",
            "type":"string",
            "description":"The formatted phone number in the contact point.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "type":"string",
            "description":"The module that created the contact point record.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the contact point record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the contact point.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "SocialNetworkPurpose":{
            "title":"Social Network Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the contact point record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The name of the external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "DoNotContactReason":{
            "title":"Do Not Contact Reason",
            "type":"string",
            "description":"Indicates the reason for \"Do Not Contact\" preference.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhonePurpose":{
            "title":"Phone Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PreferenceRequestedBy":{
            "title":"Preference Requested By",
            "type":"string",
            "description":"The list of values indicating the preference requested.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DoContactPreferenceFlag":{
            "title":"OK to Contact",
            "type":"boolean",
            "description":"Indicates whether to use a particular contact method. Defaulted to false.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"255",
            "type":"string",
            "description":"The e-mail address in the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "title":"Source System Reference Value",
            "type":"string",
            "description":"The identifier of the record from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PhoneExtension":{
            "title":"Extension",
            "maxLength":"255",
            "type":"string",
            "description":"The phone extension of the phone number in the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "type":"string",
            "description":"The party number of the partner company.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party of the partner company.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhoneType":{
            "title":"Type",
            "type":"string",
            "description":"The type of the phone number in the contact point. For example: \"FAX\" or \"WORK\" determines the type of the phone number.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DoNotContactPreferenceFlag":{
            "title":"Do Not Contact",
            "type":"boolean",
            "description":"Indicates whether the contact point is not preferred for contact.",
            "nullable":true,
            "x-queryable":false
        },
        "WebPurpose":{
            "title":"Web Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE, SALESURL, MARKETINGURL, SUPPORTURL, RSS_FEED and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EmailPurpose":{
            "title":"Email Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"The e-mail purpose for the email address in the contact point. For example: \"BUSINESS\" determines the purpose of the e-mail address.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"255",
            "type":"string",
            "description":"The phone number in the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "SocialNetworkName":{
            "title":"Social Network",
            "type":"string",
            "description":"The social network name. Note: This is an internal attribute and should not be used.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "Property":"Social Network"
            },
            "x-queryable":true
        },
        "ContactPointType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the contact point such as EMAIL or PHONE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RawPhoneNumber":{
            "title":"Phone",
            "maxLength":"255",
            "type":"string",
            "description":"The raw phone number in the contact point.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "type":"string",
            "description":"The name of the external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the contact point record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the contact point record.",
            "nullable":true,
            "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 : 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."
        }
    }
}

Links

ContactPointPurposeWebLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE_WEB%2CLookupCode%3D{WebPurpose}

The list of values indicating the purpose of the web.

The following properties are defined on the LOV link relation:

• Source Attribute: WebPurpose; Target Attribute: LookupCode
• Display Attribute: Meaning

ContactPointTypeLimitedLookUpVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCOMMUNICATION_TYPE%2CLookupCode%3D{ContactPointType}

The list of values indicating the contact point type.

The following properties are defined on the LOV link relation:

• Source Attribute: ContactPointType; Target Attribute: LookupCode
• Display Attribute: Meaning

EmailPurposeLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{EmailPurpose}

The list of values indicating the purpose of the email.

The following properties are defined on the LOV link relation:

• Source Attribute: EmailPurpose; Target Attribute: LookupCode
• Display Attribute: Meaning

InstantMessengerTypeVOVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE%2CLookupCode%3D{SocialNetworkName}

The lookup resource for social network name.

The following properties are defined on the LOV link relation:

• Source Attribute: SocialNetworkName; Target Attribute: LookupCode
• Display Attribute: LookupCode

PhonePurposeLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{PhonePurpose}

The list of values indicating the purpose of the phone.

The following properties are defined on the LOV link relation:

• Source Attribute: PhonePurpose; Target Attribute: LookupCode
• Display Attribute: Meaning

PhoneTypeLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HZ_PHONE_TYPE%2CLookupCode%3D{PhoneType}

The list of values indicating the type of the phone.

The following properties are defined on the LOV link relation:

• Source Attribute: PhoneType; Target Attribute: LookupCode
• Display Attribute: Meaning

PreferenceRequestedByLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupCode%3D{PreferenceRequestedBy}%2CLookupType%3DREQUESTED_BY

The list of values indicating the preference requested.

The following properties are defined on the LOV link relation:

• Source Attribute: PreferenceRequestedBy; Target Attribute: LookupCode
• Display Attribute: Meaning

ReasonCodesVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DREASON_CODE%2CLookupCode%3D{DoNotContactReason}

The list of values indicating the do not contact reason.

The following properties are defined on the LOV link relation:

• Source Attribute: DoNotContactReason; Target Attribute: LookupCode
• Display Attribute: Meaning

SocialNetworkPurposeLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{SocialNetworkPurpose}

The list of values indicating the purpose of the social network.

The following properties are defined on the LOV link relation:

• Source Attribute: SocialNetworkPurpose; Target Attribute: LookupCode
• Display Attribute: Meaning

VerificationStatusLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{VerificationStatus}

The list of values indicating the verification status.

The following properties are defined on the LOV link relation:

• Source Attribute: VerificationStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top