Description | Query Leads |
Name | QueryLeadIn |
Namespace | http://sap.com/xi/AP/CRM/Global |
Process Component Description | Lead Processing |
Process Component Name | LeadProcessing |
Process Component Namespace | http://sap.com/xi/AP/CRM/Global |
Deployment Unit Description | Customer Relationship Management |
Endpoint Activation | By Scoping of Process Component | Operations |
Release Status | Not Released |
An interface that queries leads based on lead or account information provided by the consumer.
The web service APCRM QUERY LEAD IN is used to query leads.
It has the Query By Elements operation which is used to query for one or more instances of the lead based on the query filter parameters passed.
A lead should exist in the system in order to get a positive result.
For certain nodes with cardinality from 0 - *, the UUID / TechnicalIDs are used as identifier for each of the respective nodes.
The QueryProcessingConditions specify how to process a query with respect to the maximum number of hits to be returned.
QueryHitsMaximumNumberValue: Maximum number of hits to be returned by an inquiry.
QueryHitsUnlimitedIndicator: Identifies the last object returned by a previous inquiry.
LastReturnedObjectID: Indicates whether the maximum number of hits to be returned by an inquiry is unlimited or not.
If QueryHitsUnlimitedIndicator = true, QueryHitsMaximumNumberValue must not be present.
Example
<ProcessingConditions> <QueryHitsMaximumNumberValue>500</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions>
All the selection elements in the query have the following selection parameters.
InclusionExclusionCode: A coded representation of the inclusion of a set into a result set or the exclusion of it.
Code Value | Description |
---|---|
E | Excluding |
I | Including |
IntervalBoundaryTypeCode: A coded representation of an interval boundary type. The meaning of scale values established by the IntervalBoundaryTypeCode is used to describe intervals by their boundaries. The values that are expressed by the interval relationship must belong to the same ordinal scale.
Code Value | Description |
---|---|
1 | Equal To |
2 | Between (excluding upper boundaries) |
3 | Between |
4 | Between (excluding both boundaries) |
5 | Between (excluding lower boundaries) |
6 | Less Than |
7 | Less Than or Equal to |
8 | Greater Than |
9 | Greater Than or Equal to |
You can find general information about Web services, their structure and consumption in the Web Services documentation.
This service can be consumed in case more information is needed for lead when customer know ID or description or AccountId or Account Name of the lead.
Description | Query leads |
Name | FindOverviewSimpleByElements |
Synchronous | yes |
Release Status | Released |
An operation to query lead data by the selection elements passed in the request.
QueryByElements is an operation to query lead data by the selection elements passed in the request.
Below are the list of selection elements available and their corresponding business context.
SelectionByElements | UI Element |
---|---|
SelectionByLeadID | Lead ID |
SelectionByLeadName | Description |
SelectionByPartyProspectPartyKeyPartyID | Account ID |
SelectionByPartyProspectPartyName | Account Name |
With this query parameter you can query Leads with a specific Lead ID. This example is requesting details for Lead with ID 114.
Request
<n0:LeadOverviewSimpleByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <LeadOverviewSimpleSelectionByElements> <SelectionByLeadID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryLeadID>114</LowerBoundaryLeadID> </SelectionByLeadID> </LeadOverviewSimpleSelectionByElements> <ProcessingConditions> <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:LeadOverviewSimpleByElementsQuery_sync>
Response
<n0:LeadOverviewSimpleByElementsResponse_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS29B1039F7EE19E4BE1B8:804" xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <LeadOverview> <LeadUUID></LeadUUID> <LeadID></LeadID> <LeadName></LeadName> <LifeCycleStatusCode></LifeCycleStatusCode> <PartyProspectPartyFormattedName></PartyProspectPartyFormattedName> </LeadOverview> <ProcessingConditions> <ReturnedQueryHitsNumberValue></ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator></MoreHitsAvailableIndicator> <LastReturnedObjectID></LastReturnedObjectID> </ProcessingConditions> <Log/> </n0:LeadOverviewSimpleByElementsResponse_sync>
With this query parameter you can query Leads by the description. This example is requesting details for Lead having description maintained as "sap"
Request
<n0:LeadOverviewSimpleByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <LeadOverviewSimpleSelectionByElements> <SelectionByLeadName> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryLeadName languageCode="EN">sap</LowerBoundaryLeadName> </SelectionByLeadName> </LeadOverviewSimpleSelectionByElements> <ProcessingConditions> <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:LeadOverviewSimpleByElementsQuery_sync>
With this query parameter you can query Leads with a specific Account ID.This example is requesting details for Lead with Account ID MC9785.
Request
<n0:LeadOverviewSimpleByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <LeadOverviewSimpleSelectionByElements> <SelectionByPartyProspectPartyKeyPartyID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryPartyID>MC9785</LowerBoundaryPartyID> </SelectionByPartyProspectPartyKeyPartyID> </LeadOverviewSimpleSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>1</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator /> <LastReturnedObjectID /> </ProcessingConditions> </n0:LeadOverviewSimpleByElementsQuery_sync>
With this query parameter you can query Leads with a specific Account name.This example is requesting details for Lead by Account name with pattern "sap".
Request
<n0:LeadOverviewSimpleByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <LeadOverviewSimpleSelectionByElements> <SelectionByPartyProspectPartyName> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryPartyName languageCode="EN">*sap*</LowerBoundaryPartyName> </SelectionByPartyProspectPartyName> </LeadOverviewSimpleSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>1</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator /> <LastReturnedObjectID /> </ProcessingConditions> </n0:LeadOverviewSimpleByElementsQuery_sync>