Get a contact point

get

/crmRestApi/resources/11.13.18.05/hubPersons/{PartyNumber}/child/ContactPoint/{ContactPointId}

Request

Path Parameters
  • The unique identifier of the contact point.
  • The unique alternate identifier for the person party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

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

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : hubPersons-ContactPoint-item-response
Type: object
Show Source
  • Title: Conflict ID
    Default Value: 0
    The unique identifier of the conflict.
  • Title: Contact Point ID
    Read Only: true
    The unique identifier of the contact point.
  • Title: Type
    Maximum Length: 30
    The type of contact point.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Created by Application
    Default Value: HZ_WS
    The user who created the module.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: OK to Contact
    Indicates whether to use a particular contact method.
  • Title: Do Not Contact
    The contact preference flag that indicates DNC option.
  • Title: Do Not Contact Reason
    The reason code for the contact preference.
  • Title: Email
    Maximum Length: 255
    The email address of the contact point.
  • Title: Email Purpose
    Maximum Length: 30
    The purpose of the email.
  • Title: Phone Number
    Read Only: true
    Maximum Length: 255
    The formatted phone number of the contact point.
  • Title: Last Update Date
    Read Only: true
    The date when the contact point was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the contact point.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the contact point.
  • Links
  • Title: Object Version Number
    The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
  • Title: Party ID
    The unique identifier of the party.
  • Title: Registry ID
    The party number. Inactive records can't be updated.
  • Title: Party Source System
    The name of external source system of the account, contact, or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
  • Title: Party Source System Reference Value
    The unique identifier of the relationship from external source system.
  • Title: Area Code
    Maximum Length: 255
    The area code for the telephone number.
  • Title: Phone Country Code
    Maximum Length: 255
    The country code of the phone number.
  • Title: Extension
    Maximum Length: 255
    The extension number of the phone line number like office desk extension.
  • Title: Phone
    Maximum Length: 255
    The phone number of the contact point.
  • Title: Phone Purpose
    Maximum Length: 30
    Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE. Sample values are ASSISTANT, PERSONAL, HOME_BUSINESS, BUSINESS etc.
  • Title: Type
    The type of the phone.
  • Title: Preference Requested By
    Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup.
  • Title: Primary
    Maximum Length: 1
    Default Value: false
    Indicates whether the phone number is preferred.
  • Title: Phone
    Maximum Length: 255
    The phone number in raw format.
  • Title: User ID
    The unique identifier for the social network.
  • Title: Social Network
    The social network type.
  • 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 etc.
  • Title: Source System
    The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
  • Title: Source System Reference Value
    The unique identifier for the accounts party from the external source system specified in the attribute SourceSystem. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
  • Title: Status
    Maximum Length: 30
    Default Value: A
    The status of the contact point.
  • Title: URL
    The URL associated with the contact point.
  • Title: Verification Date
    The date of verification of the phone or email contact point.
  • Title: Verification Status
    Maximum Length: 30
    The status of the verification for phone or email contact points. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. The value ORA_PARTIALLY_VALID is applicable only for email. Default value is blank which indicates that values are not verified.
  • Title: Web Purpose
    Maximum Length: 30
    Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB. Sample values are HOMEPAGE, SALESURL, MARKETINGURL, SUPPORTURL, RSS_FEED etc.
Back to Top