1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Sales Leads
  4. Sales Lead Contacts

Get all sales lead contacts

get

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTcMembers1

Request

Path Parameters
  • 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
  • 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
  • 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:

    • LeadContactUserKey: Finds the lead contact with the specified lead id and party id.
      Finder Variables:
      • LeadId; integer; The parameter used to query by the lead id.
      • PartyId; integer; The parameter used to query by the party id.
    • LeadNumberAndPartyNumberRF: Finds the lead contact with the specified lead number and party number.
      Finder Variables:
      • LeadNumber; string; The parameter used to query the resource.
      • PartyNumber; string; The parameter used to query the resource.
    • PrimaryKey: Finds the sales team members on the lead matching the provided lead identifier.
      Finder Variables:
      • LeadMemberId; integer; The unique identifier of the Lead member.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • City; string; City associated with the identifying address associated with this lead contact.
    • ConflictId; integer; The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
    • ContactDoNotCallFlag; boolean; 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; 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; Indicates whether the sales lead person can be contacted.
    • ContactJobTitle; string; The label displaying the job title of a contact in his company.
    • CreatedBy; string; The user who created this sales lead contact.
    • CreationDate; string; The date and time when this sales lead contact is created.
    • EmailAddress; string; The e-mail address associated with the sales lead contact.
    • FormattedPhoneNumber; string; The formatted phone number of the lead contact.
    • JobTitle; string; The job title of the sales lead contact.
    • LastUpdateDate; string; The date and time of the last update of the sales lead contact.
    • LastUpdateLogin; string; The session login associated to the user who last updated the sales lead record.
    • LastUpdatedBy; string; The user who last updated the sales lead contact.
    • LeadId; integer; The unique identifier of the sales lead for this sales lead contact.
    • LeadMemberId; integer; The unique identifier for the sales lead contact.
    • LeadNumber; string; The alternate unique identifier of the lead.
    • OrgContactId; integer; The unique identifier of the Organization for this sales lead contact.
    • PartyId; integer; The unique identifier of the lead to which the contact is associated.
    • PartyName; string; The name of the party associated with the lead contact.
    • PartyNumber; string; The party number of the sales lead contact.
    • PartyType; string; The type of the party recorded as lead contact. Possible values are person, organization or group.
    • PartyUsageCode; string; The party usage recorded for this lead contact in the customer master.
    • PersonFirstName; string; The first name of the lead contact.
    • PersonLastName; string; The last name or surname of a lead contact.
    • PersonTitle; string; The title associated with the lead contact. This is not the same as the job title.
    • PostalCode; string; Postal code part of the identifying address associated with this lead contact.
    • PrimaryFlag; boolean; Indicates whether a lead contact is the primary contact. The primary lead contact is also the lead owner.
    • RelationshipId; integer; The unique relationship identifier for this lead contact. This represents the relation of this lead contact with lead customer.
    • Role; string; The role of lead contact in the context of this lead.
    • State; string; State part of the identifying address associated with this lead contact.
  • 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
  • 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 : leads-MklLeadTcMembers1
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : leads-MklLeadTcMembers1-item-response
Type: object
Show Source
  • Title: Existing Account
    Read Only: true
    Maximum Length: 900
    The account name associated with lead contacts.
  • Title: City
    Read Only: true
    Maximum Length: 60
    City associated with the identifying address associated with this lead contact.
  • 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.
  • 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.
  • 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.
  • Title: Do Not Mail
    Read Only: true
    Maximum Length: 1
    Indicates whether the sales lead person can be contacted.
  • Title: Job Title
    The label displaying the job title of a contact in his company.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created this sales lead contact.
  • Title: Creation Date
    Read Only: true
    The date and time when this sales lead contact is created.
  • Title: Email
    The e-mail address associated with the sales lead contact.
  • 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.
  • Title: Phone
    The formatted phone number of the lead contact.
  • Title: Title
    Read Only: true
    Maximum Length: 100
    The job title of the sales lead contact.
  • Title: Last Updated Date
    Read Only: true
    The date and time of the last update of the sales lead contact.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the sales lead contact.
  • Title: Last Updated Login
    Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the sales lead record.
  • Title: Lead ID
    The unique identifier of the sales lead for this sales lead contact.
  • Title: Lead Contact ID
    The unique identifier for the sales lead contact.
  • Title: Lead Number
    Maximum Length: 30
    The alternate unique identifier of the lead.
  • Links
  • Title: Organization Contact ID
    Read Only: true
    The unique identifier of the Organization for this sales lead contact.
  • Title: Contact Party ID
    The unique identifier of the lead to which the contact is associated.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The name of the party associated with the lead contact.
  • Title: Contact Party Number
    Read Only: true
    Maximum Length: 30
    The party number of the sales lead contact.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    The type of the party recorded as lead contact. Possible values are person, organization or group.
  • Title: Party Usage Code
    Maximum Length: 30
    The party usage recorded for this lead contact in the customer master.
  • Title: First Name
    Read Only: true
    Maximum Length: 150
    The first name of the lead contact.
  • Title: Last Name
    Read Only: true
    Maximum Length: 150
    The last name or surname of a lead contact.
  • Title: Title
    Read Only: true
    Maximum Length: 60
    The title associated with the lead contact. This is not the same as the job title.
  • 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.
  • Title: Postal Code
    Read Only: true
    Maximum Length: 60
    Postal code part of the identifying address associated with this lead contact.
  • Read Only: true
    The account party identifier of the account associated to the lead contact.
  • Title: Primary
    Maximum Length: 1
    Indicates whether a lead contact is the primary contact. The primary lead contact is also the lead owner.
  • Title: Relationship ID
    The unique relationship identifier for this lead contact. This represents the relation of this lead contact with lead customer.
  • Title: Function
    Maximum Length: 30
    The role of lead contact in the context of this lead.
  • Title: State
    Read Only: true
    Maximum Length: 60
    State part of the identifying address associated with this lead contact.
Back to Top

Examples

cURL Command

The following example shows how to get all contacts 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

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "items": [
    {
      "LeadMemberId": 300100092582196,
      "RelationshipId": 300100090715458,
      "PartyUsageCode": null,
      "PartyId": 300100090715456,
      "Role": null,
      "CreatedBy": "MHoope",
      "CreationDate": "2016-11-07T03:25:48-08:00",
      "LastUpdatedBy": "MHoope",
      "LastUpdateDate": "2016-11-07T03:25:53-08:00",
      "LeadId": 300100092582093,
      "PartyName": "Test Contact",
      "PrimaryFlag": false,
      "PersonLastName": "Contact",
      "PersonFirstName": "Test",
      "PartyType": "PERSON",
      "PersonTitle": null,
      "FormattedPhoneNumber": "+1 (2222)222222 x22",
      "PartyNumber": "CDRM_568258",
      "EmailAddress": "testContact@oracle.com",
      "OrgContactId": 300100090715459,
      "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/300100092582196",
          "name": "MklLeadTcMembers1",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000005737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
          }
        },
.......
 ]
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1",
      "name": "MklLeadTcMembers1",
      "kind": "Collection"
    }
  ]
}
Back to Top