Get all contact points
get
/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.
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds a contact point with the specified primary key.
Finder Variables:- ContactPointId; integer; The unique identifier of the contact point.
- PrimaryKey: Finds a contact point with the specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ConflictId; integer; The unique identifier of the conflict. Note: This is an internal attribute and should not be used.
- ContactPointId; integer; The unique identifier of the contact point.
- ContactPointType; string; The type of the contact point such as EMAIL or PHONE.
- CreatedBy; string; The user who created the contact point record.
- CreationDate; string; The date when the contact point record was created.
- EmailAddress; string; The e-mail address in the contact point.
- EmailPurpose; string; 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; The formatted phone number in the contact point.
- LastUpdateDate; string; The date when the contact point record was last updated.
- LastUpdateLogin; string; The login of the user who last updated the contact point record.
- LastUpdatedBy; string; The user who last updated the contact point record.
- ObjectVersionNumber; integer; The object version number. (This is an internal attribute and should not be used)
- PartyId; integer; The unique identifier of the party of the partner company.
- PhoneAreaCode; string; The area code of the phone number in the contact point.
- PhoneCountryCode; string; The phone country code of the phone number in the contact point.
- PhoneExtension; string; The phone extension of the phone number in the contact point.
- PhoneNumber; string; The phone number in the contact point.
- PhonePurpose; string; 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.
- PrimaryFlag; boolean; Indicates whether the contact point is primary.
- RawPhoneNumber; string; 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; 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.
- Status; string; The status of the contact point.
- URL; string; The URL in the contact point.
- VerificationDate; string; The date of verification of the phone or email contact point.
- VerificationStatus; string; The list of values indicating the purpose of the social network.
- WebPurpose; string; 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
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:
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.
Root Schema : partnerContacts-contactPoints
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partnerContacts-contactPoints-item-response
Type:
Show Source
object
-
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.
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.