Get a contact point
get
/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contactPoints/{ContactPointId}
Request
Path Parameters
-
CompanyNumber(required): string
The alternate key identifier of the partner's company.
-
ContactPointId(required): integer(int64)
The unique identifier of the contact point.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : partners-contactPoints-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. Note: This is an internal attribute and should not be used. -
ContactPointId: integer
(int64)
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
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)
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
Indicates whether the contact point is not preferred for contact.
-
DoNotContactReason: string
Indicates the reason for "Do Not Contact" preference.
-
EmailAddress: string
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
Read Only:
true
Maximum Length:255
The formatted phone number in the contact point. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the contact point record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the contact point record. -
LastUpdateLogin: string
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)
The object version number. (This is an internal attribute and should not be used)
-
PartyId: integer
(int64)
The unique identifier of the party of the partner company.
-
PartyNumber: string
The party number of the partner company.
-
PartySourceSystem: string
The name of the external source system.
-
PartySourceSystemReferenceValue: string
The identifier of the record from external source system.
-
PhoneAreaCode: string
Maximum Length:
255
The area code of the phone number in the contact point. -
PhoneCountryCode: string
Maximum Length:
255
The phone country code of the phone number in the contact point. -
PhoneExtension: string
Maximum Length:
255
The phone extension of the phone number in the contact point. -
PhoneNumber: string
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
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
Maximum Length:
255
The raw phone number in the contact point. -
SocialNetworkId: string
The social network identifier. Note: This is an internal attribute and should not be used.
-
SocialNetworkName: string
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 etc. -
SourceSystem: string
The name of the external source system.
-
SourceSystemReferenceValue: string
The identifier of the record from external source system.
-
Status: string
Maximum Length:
30
Default Value:A
The status of the contact point. -
URL: string
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 etc.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ContactPointPurposeWebLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE_WEB%2CLookupCode%3D{WebPurpose}
The list of values indicating the purpose of the web. - finder:
- ContactPointTypeLimitedLookUpVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCOMMUNICATION_TYPE%2CLookupCode%3D{ContactPointType}
The list of values indicating the contact point type. - finder:
- EmailPurposeLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{EmailPurpose}
The list of values indicating the purpose of the email. - finder:
- InstantMessengerTypeVOVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE%2CLookupCode%3D{SocialNetworkName}
The lookup resource for social network name. - finder:
- PhonePurposeLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{PhonePurpose}
The list of values indicating the purpose of the phone. - finder:
- PhoneTypeLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_PHONE_TYPE%2CLookupCode%3D{PhoneType}
The list of values indicating the type of the phone. - finder:
- PreferenceRequestedByLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{PreferenceRequestedBy}%2CLookupType%3DREQUESTED_BY
The list of values indicating the preference requested. - finder:
- ReasonCodesVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DREASON_CODE%2CLookupCode%3D{DoNotContactReason}
The list of values indicating the DO NOT contact reason. - finder:
- SocialNetworkPurposeLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCONTACT_POINT_PURPOSE%2CLookupCode%3D{SocialNetworkPurpose}
The list of values indicating the purpose of the social network. - finder:
- VerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{VerificationStatus}
The list of values indicating the verification status. - finder: