Get a sales lead contact
get
/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}
Request
Path Parameters
-
LeadMemberId(required): integer(int64)
The unique identifier for the sales lead contact.
-
leadsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Sales Leads resource and used to uniquely identify an instance of Sales Leads. The client should not generate the hash key value. Instead, the client should query on the Sales Leads collection resource in order to navigate to a specific instance of Sales Leads to get the hash key.
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:
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 : leads-MklLeadTcMembers1-item-response
Type:
Show Source
object
-
AccountName: string
Title:
Existing Account
Read Only:true
Maximum Length:900
The account name associated with lead contacts. -
City: string
Title:
City
Read Only:true
Maximum Length:60
City associated with the identifying address associated with this lead contact. -
ConflictId: integer
Title:
Conflict Identifier
Default Value:0
The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server. -
ContactDoNotCallFlag: boolean
Title:
Do Not Call
Read Only:true
Maximum Length:1
Indicates if the user can call the person. If the value is True, then the user can not call the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. You can review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
ContactDoNotContactFlag: boolean
Title:
Do Not Contact
Read Only:true
Maximum Length:1
Indicates if the user can contact the person by phone, e-mail, or mail. If the value is True, then the user can not contact the person. The default value is False. -
ContactDoNotMailFlag: boolean
Title:
Do Not Mail
Read Only:true
Maximum Length:1
Indicates whether the sales lead person can be contacted. -
ContactJobTitle: string
Title:
Job Title
The label displaying the job title of a contact in his company. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created this sales lead contact. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when this sales lead contact is created. -
EmailAddress: string
Title:
Email
The e-mail address associated with the sales lead contact. -
EmailPreference: string
Title:
Email Preference
Read Only:true
Maximum Length:255
Indicates if the lead contact has an email preference of do not email, ok to email, or no value. -
FormattedPhoneNumber: string
Title:
Phone
The formatted phone number of the lead contact. -
JobTitle: string
Title:
Title
Read Only:true
Maximum Length:100
The job title of the sales lead contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time of the last update of the sales lead contact. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the sales lead contact. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the sales lead record. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the sales lead for this sales lead contact. -
LeadMemberId: integer
(int64)
Title:
Lead Contact ID
The unique identifier for the sales lead contact. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The alternate unique identifier of the lead. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgContactId: integer
(int64)
Title:
Organization Contact ID
Read Only:true
The unique identifier of the Organization for this sales lead contact. -
PartyId: integer
(int64)
Title:
Contact Party ID
The unique identifier of the lead to which the contact is associated. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the party associated with the lead contact. -
PartyNumber: string
Title:
Contact Party Number
Read Only:true
Maximum Length:30
The party number of the sales lead contact. -
PartyType: string
Title:
Type
Read Only:true
Maximum Length:30
The type of the party recorded as lead contact. Possible values are person, organization or group. -
PartyUsageCode: string
Title:
Party Usage Code
Maximum Length:30
The party usage recorded for this lead contact in the customer master. -
PersonFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the lead contact. -
PersonLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name or surname of a lead contact. -
PersonTitle: string
Title:
Title
Read Only:true
Maximum Length:60
The title associated with the lead contact. This is not the same as the job title. -
PhonePreference: string
Title:
Phone Preference
Read Only:true
Maximum Length:255
Indicates whether the lead contact has a phone preference of do not call, ok to call, or no value. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
Postal code part of the identifying address associated with this lead contact. -
PrimaryCustomerId: integer
(int64)
Read Only:
true
The account party identifier of the account associated to the lead contact. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates whether a lead contact is the primary contact. The primary lead contact is also the lead owner. -
RelationshipId: integer
(int64)
Title:
Relationship ID
The unique relationship identifier for this lead contact. This represents the relation of this lead contact with lead customer. -
Role: string
Title:
Function
Maximum Length:30
The role of lead contact in the context of this lead. -
State: string
Title:
State
Read Only:true
Maximum Length:60
State part of the identifying address associated with this lead contact.
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
- HzLookupPVO1
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_BUY_ROLE_CODE
The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing. - finder:
Examples
cURL Command
The following example shows how to get a contact by submitting a GET request on the REST resource using cURL.
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1/300100092582195
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "LeadMemberId" : 300100092582195, "RelationshipId" : null, "PartyUsageCode" : null, "PartyId" : 300100091395685, "Role" : null, "CreatedBy" : "MHoope", "CreationDate" : "2016-11-07T03:24:53-08:00", "LastUpdatedBy" : "MHoope", "LastUpdateDate" : "2016-11-07T03:25:05-08:00", "LeadId" : 300100092582093, "PartyName" : "Auto04c78940149Rel2 Last", "PrimaryFlag" : true, "PersonLastName" : "Last", "PersonFirstName" : "Auto04c78940149Rel2", "PartyType" : "PERSON", "PersonTitle" : null, "FormattedPhoneNumber" : null, "PartyNumber" : "CDRM_631453", "EmailAddress" : null, "OrgContactId" : null, "JobTitle" : null, "ContactDoNotCallFlag" : false, "ContactDoNotContactFlag" : false, "links" : [ { "rel" : "self", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1/300100092582195", "name" : "MklLeadTcMembers1", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000005737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1/300100092582195", "name" : "MklLeadTcMembers1", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100092582093", "name" : "leads", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1/300100092582195/lov/HzLookupPVO1", "name" : "HzLookupPVO1", "kind" : "Collection" } ] }