Definition
An interface to query marketing communication type (category) permission data.
Business Context and Use
The web service interface QueryMarketingPermissionCommunicationTypePermissionIn enables you to connect external applications to your SAP system and to query and read marketing communication type (category) permission data in your system. The web service interface is relevant if your company wants to access and manage marketing communication type (category) permission data from external applications.
It has the FindByElements operation which is used to query for one or more instances of Marketing Permission Communication Type (Category) Permission based on the query filter parameters passed.
Example structure:
<n0:MarketingPermissionCommunicationTypePermissionByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <MarketingPermissionCommunicationTypePermissionByElementsQuerySelectionByElements>
<SelectionByBusinessPartnerUUID>...</SelectionByBusinessPartnerUUID>
<SelectionByAlternativeID>...</SelectionByAlternativeID>
<SelectionBySystemAdministrativeDataLastChangeDateTime>...</SelectionBySystemAdministrativeDataLastChangeDateTime>
</MarketingPermissionCommunicationTypePermissionByElementsQuerySelectionByElements>
<ProcessingConditions>
<QueryHitsMaximumNumberValue>100</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID/>
</ProcessingConditions>
<RequestedElements>
<MarketingPermission/>
</RequestedElements>
</n0:MarketingPermissionCommunicationTypePermissionByElementsQuery_sync>
Prerequisites
Marketing communication type (category) permissions should exist in the system in order to get a positive result.
Constraints and Integrity Conditions
Processing Conditions
Example:
<ProcessingConditions>
<QueryHitsMaximumNumberValue>300</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
</ProcessingConditions>
Requested Elements
Example for requesting all data (code snippet):
<RequestedElements marketingPermissionTransmissionRequestCode="1">
<MarketingPermission channelPermissionTransmissionRequestCode="1"/>
</RequestedElements>
or (default is '1')
<RequestedElements />
or do not specify this element.
More Information
General Information
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Scenarios
Example to find a marketing communication type (category) permission for a certain business partner ID ('1234'):
<n0:MarketingPermissionCommunicationTypePermissionByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<MarketingPermissionCommunicationTypePermissionByElementsQuerySelectionByElements>
<SelectionByBusinessPartnerID>
<InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>1234</LowerBoundaryIdentifier> <UpperBoundaryIdentifier/>
</SelectionByBusinessPartnerID>
</MarketingPermissionCommunicationTypePermissionByElementsQuerySelectionByElements>
<ProcessingConditions>
<QueryHitsMaximumNumberValue>93</QueryHitsMaximumNumberValue>
<QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
<LastReturnedObjectID/>
</ProcessingConditions>
<RequestedElements>
<MarketingPermission/>
</RequestedElements>
</n0:MarketingPermissionCommunicationTypePermissionByElementsQuery_sync>
Definition
To query marketing communication type (category) permission data by elements.
Business Context and Use
The request message of the operation FindByElements contains the QueryByElements that group all possible selection parameters.
Structure
Find By Elements
| Selection Parameter |
UI elements |
|---|
| <SelectionByBusinessPartnerUUID> |
no UI element; Business Partner UUID |
| <SelectionByBusinessPartnerID> |
Business Partner ID |
| <SelectionByBusinessPartnerRoleCode> |
no UI element; Business Role |
| <SelectionByAternativeID> |
no UI element; Alternative ID |
| <SelectionBySystemAdministrativeDataLastChangeDateTime> |
no UI element; point in time when the marketing permission is changed. It is an accurate-to-the-second time-point of a calendar day in time zone UTC. |
The supported Interval Boundary Type Code values depend on the type of the selection element:
| Selection Parameter Type |
Supported Interval Boundary Type Code values |
|---|
| ID |
All values are allowed. |
| Date Time |
All values are allowed. |
| Code |
Only value '1' (= Equal to) without wildcards is allowed. |
Example to find a marketing communication type permission (category) for a certain business partner ID ('1234') and a certain communication type ('004'):
<n0:MarketingPermissionCommunicationTypePermissionByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<MarketingPermissionCommunicationTypePermissionByElementsQuerySelectionByElements>
<SelectionByBusinessPartnerID>
<InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>1234</LowerBoundaryIdentifier> <UpperBoundaryIdentifier/>
</SelectionByBusinessPartnerID>
</MarketingPermissionCommunicationTypePermissionByElementsQuerySelectionByElements>
<ProcessingConditions>
<QueryHitsMaximumNumberValue>93</QueryHitsMaximumNumberValue>
<QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator>
<LastReturnedObjectID/>
</ProcessingConditions>
<RequestedElements>
<MarketingPermission/>
</RequestedElements>
</n0:MarketingPermissionCommunicationTypePermissionByElementsQuery_sync>
Response
The response contains the list of found marketing permission communication type (category) permissions, log items and processing conditions.
Show full documentation
Show full documentation