Description | Query Target Groups |
Name | QueryTargetGroupContactInformation |
Namespace | http://sap.com/xi/A1S/Global |
Process Component Description | Campaign Management |
Process Component Name | CampaignManagement |
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 | Released |
An interface to query target group contact information data.
This web service is used to query target group member contact information.
The web service interface ‘II_A1SCRM_TG_QUERY_CI’ offers the operation ‘FindByElements’ which is used to query for one or more instances of the Target Group based on the query filter parameters passed.
Example to query Target Group created and Target Group ID between an interval:
<n0:TargetGroupQueryContactInformationRequestMessage xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <TargetGroupSelectionByElements> <SelectionByID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>3</IntervalBoundaryTypeCode> <LowerBoundaryID>61</LowerBoundaryID> <UpperBoundaryID>63</UpperBoundaryID> </SelectionByID> <SelectionByCreationDateTime> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>3</IntervalBoundaryTypeCode> <LowerBoundaryCrtDateTime>2015-02-09T00:00:00Z</LowerBoundaryCrtDateTime> <UpperBoundaryCrtDateTime>2015-02-09T23:59:59Z</UpperBoundaryCrtDateTime> </SelectionByCreationDateTime> </TargetGroupSelectionByElements> <ProcessingConditions> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:TargetGroupQueryContactInformationRequestMessage>
A target group 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 |
Many external applications consuming web services have special requirements and restrictions regarding the format of WSDLs. Some external applications require service definition WSDLs describing the web service signature. This is normally sufficient for the creation of static client-side proxies. Other externalapplications, normally those that do not create static client-side proxies, require binding WSDLs including
the endpoint definition and authentication policy information.
In both cases, it may be the case that the external application imposes special restrictions on the structure or the size of WSDLs.
Microsoft InfoPath requires binding WSDLs and considers elements with the attribute "minOccurs=0" as "mandatory". However "minOccurs=0" means "optional" in SAP web services. In order to circumvent this problem, the WSDL must be saved locally and an additional attribute "nillable=true" must be added to make a query parameter optional for Microsoft InfoPath.
For very small clients such as mobile devices, the size of the WSDL itself may become a problem. In most cases the client only requires a very small part of the signature, but due to the complexity of the WSDL they may end up with long runtimes during serialization of the request or deserialization of the response. In order to circumvent this problem, the WSDL must be saved locally and the optional parts of the signature have to be removed before the WSDL is imported or static client-side proxies are generated.
External applications have to take into account that web service request and response message types can be enhanced with additional elements and attributes. Enhancements can be created by SAP, SAP partners, and key users. Enhancements of request message types are always optional elements or attributes. The SAP system does not require the external application to provide values in the request. Enhancements of response message types can contain mandatory elements or attributes. The external application must be able to process the extended response successfully.
XML element and attribute names are always stable. Technical definitions of data types can be enhanced in a compatible way. This may result in changed data type names. External applications can rely on XML element names and attribute names, but should not rely on data type names.
Note: You can download the WSDL file for any web service here:
Application and User Management work center -> Input Output Management Communication -> Arrangement.
User Management work center -> Service Explorer view.
General Information
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Query Target Group Contact informaton and retrieve all elements.
<n0:TargetGroupQueryContactInformationRequestMessage xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <TargetGroupSelectionByElements> <SelectionByID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>3</IntervalBoundaryTypeCode> <LowerBoundaryID>61</LowerBoundaryID> <UpperBoundaryID>63</UpperBoundaryID> </SelectionByID> <SelectionByStatus> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryStatus> <LifeCycleStatusCode>1</LifeCycleStatusCode> </LowerBoundaryStatus> </SelectionByStatus> <SelectionByMemberNumberValue> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryMemberNumberValue>2</LowerBoundaryMemberNumberValue> </SelectionByMemberNumberValue> <SelectionBySearchText> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundarySearchText>*2158</LowerBoundarySearchText> </SelectionBySearchText> </TargetGroupSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>53</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> <TargetGroupQueryContactInformationRequestElements TargetGroupContactInfoTransmissionRequestCode="1"> <TargetGroup TargetGroupMemberTransmissionRequestCode="1"> </TargetGroup> </TargetGroupQueryContactInformationRequestElements> </n0:TargetGroupQueryContactInformationRequestMessage>
<n0:TargetGroupQueryContactInformationResponseMessage xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TASD0898ACCEA64AE880AB8:804"> <TargetGroupContactInfo> <TargetGroup>62</TargetGroup> <TargetGroupMember> <MemberUUID>00163e07-3d66-1ee4-ac88-af55e26e8262</MemberUUID> <AddressableChecklistResultStatusCode>1</AddressableChecklistResultStatusCode> <TargetGroupMemberContactInformation> <CustomerInternalID>MC9785</CustomerInternalID> <CustomerFormattedName>Silverstar Wholesale Corp</CustomerFormattedName> <FormattedPostalAddressDescription>145 Wolf Rd / Albany NY 12205 / US</FormattedPostalAddressDescription> <PreferredCommunicationMediumTypeCode>INT</PreferredCommunicationMediumTypeCode> <Communication> <TelephoneFormattedNumberDescription>+1 (518) 482-4867</TelephoneFormattedNumberDescription> <FacsimileFormattedNumberDescription>+1 (518) 482-4867</FacsimileFormattedNumberDescription> <EmailURI>info@silverstar-wholesale.us</EmailURI> </Communication> </TargetGroupMemberContactInformation> </TargetGroupMember> <TargetGroupMember> <MemberUUID>00163e07-3d66-1ee4-ac88-af55e26f6262</MemberUUID> <AddressableChecklistResultStatusCode>1</AddressableChecklistResultStatusCode> <TargetGroupMemberContactInformation> <CustomerInternalID>MC14998</CustomerInternalID> <CustomerFormattedName>SanGaWa Großhandels</CustomerFormattedName> <ContactPersonInternalID>MCP14998</ContactPersonInternalID> <ContactPersonFormattedName>First Last</ContactPersonFormattedName> <AddressCode>0002</AddressCode> <Person> <GivenName>First</GivenName> <FamilyName>Last</FamilyName> <GenderCode>1</GenderCode> </Person> </TargetGroupMemberContactInformation> </TargetGroupMember> </TargetGroupContactInfo> <ProcessingConditions> <QueryHitsMaximumNumberValue>1</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID>00163E073D661EE4AC88AF55E2610262</LastReturnedObjectID> </ProcessingConditions> </n0:TargetGroupQueryContactInformationResponseMessage>
Description | Find by elements |
Name | FindByElements |
Synchronous | yes |
Release Status | Released |
To query target group contact information by elements.
FindByElements is an operation to query target group contact information data by the selections elements passed in the request.
The request message of the operation FindByElements contains the SelectionByElements node that groups all possible selection parameters.
The response message of the operation FindByElements contains the TargetGroupContactInfo node that groups all query results.
Below are the list of selection elements available and their corresponding business context with the UI.
Parameters | Description | Data Type |
---|---|---|
SelectionByID | Target Group ID | Identifier |
SelectionByDescription | Target Group Description | Name |
SelectionByCreationDateTime | Target Group Creation Date | DateTime |
SelectionByLastChangedDateTime | Target Group Last change Date | DateTime |
SelectionByMemberNumberValue | Target Group Member Number Value | NumberValue |
SelectionByStatus | Target Group Status | Status |
SelectionBySearchText | Search Text | NA |
"IntervalBoundaryTypeCode" field is a mandatory field in each of the Selection tags. This field takes values as given in the generic document.
In the ProcessingConditions tag, "QueryHitsUnlimitedIndicator" field is mandatory which takes value 'True' or 'False'.
The format in which the date should be given is YYYY-MM-DDThh:mm:ss(.sss)Z
Example: 2015-11-27T15:30:00Z
TargetGroupStatus
Code | Value |
---|---|
1 | Active |
2 | Blocked |
3 | Obsolete |
This is a sample request for query by target group ID and to return only 30 records.
<n0:TargetGroupQueryContactInformationRequestMessage xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <TargetGroupSelectionByElements> <SelectionByID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryID>*</LowerBoundaryID> </SelectionByID> </TargetGroupSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>30</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:TargetGroupQueryContactInformationRequestMessage>