| Description | Query Phone Call Activities |
| Name | QueryPhoneCallActivityIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Activity Management |
| Process Component Name | ActivityManagement |
| Process Component Namespace | http://sap.com/xi/AP/FO/Activity/Global |
| Deployment Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Not Released |
An interface to query phone call activity data.
The web service interface Query phone call Activity enables you to connect external applications to your SAP system and to query and read phone call activities within your system. The web service interface is relevant if your company wants to access and manage phone call activity data from external applications.
The web service interface Query phone call Activity offers the operation FindByElements.
A phone call activity should exist in the system in order to get a positive result.
Query operations are mass-enabled stateless synchronous web service operations. Transferring or requesting amounts of data that are too large causes communication timeouts. The web service consumer (external application) is responsible for ensuring reasonable sizes for mass operations.
The query processing conditions specify how to process a query with respect to the maximum number of hits to be returned.
Query request messages provide the following processing parameters:
Query hits maximum number value (element name QueryHitsMaximumNumberValue): Maximum number of hits to be returned by an inquiry.
Query hits unlimited indicator (element name QueryHitsUnlimitedIndicator): Indicates whether the maximum number of hits to be returned by an inquiry is unlimited or not.
Last returned object ID (element name LastReturnedObjectID): Identifies the last object returned by a previous inquiry.
Note: If QueryHitsUnlimitedIndicator = true, QueryHitsMaximumNumberValue must not be filled.
Query response messages provide the following elements:
Returned query hits number value (element name ReturnedQueryHitsNumberValue): The number of hits returned by an inquiry.
More hits available indicator (element name MoreHitsAvailableIndicator): Indicates whether there are more than ReturnedQueryHitsNumberValue hits matching the selection criteria or not.
Last returned object ID (element name LastReturnedObjectID): Identifies the last object returned by this inquiry.
Note: Processing conditions can be used for the paging of query results. However, it is crucial not to change the query selection parameters from request to request. Otherwise, the query result might change.
Query selection parameters are mainly exposed as select options or ranges with an inclusion/exclusion code, interval boundary type code, lower boundary value, and upper boundary value.
The inclusion/exclusion code (element name InclusionExclusionCode) specifies the inclusion or exclusion of a set into a result set.
| Inclusion Exclusion Code | Description |
|---|---|
| E | Excluding |
| I | Including |
The interval boundary type code (element name IntervalBoundaryTypeCode) is used to describe intervals by their boundaries. Depending on the operator, the lower boundary value or both boundary values are relevant.
| Interval Boundary Type Code | Name | Description | |
|---|---|---|---|
| 1 | Equal to | Single value | = X |
| 2 | Between (excluding upper boundary) | Interval with closed lower and open upper boundary | [X, Y) |
| 3 | Between | Interval with open lower and open upper boundary | (X, Y) |
| 4 | Between (excluding both boundaries) | Interval with open lower and open upper boundary | (X, Y) |
| 5 | Between (excluding lower boundary) | Interval with open lower and closed upper boundary | (X, Y] |
| 6 | Less than | Interval with unlimited lower and open upper boundary | < X |
| 7 | Less Than or Equal to | Interval with unlimited lower and closed upper boundary | <= X |
| 8 | Greater Than | Interval with open lower and unlimited upper boundary | > X |
| 9 | Greater Than or Equal to | Interval with closed lower and unlimited upper boundary | = X |
Requested elements (element name RequestedElements) enable web service consumer to reduce the size of query response messages. Therefore, transmission and response times are reduced, thus avoiding timeouts.
Requested elements contain transmission request codes for controlling the transmission of corresponding query response node elements.
The transmission request codes are modeled as xml attributes following the syntax: <element name>TransmissionRequestCode.
The prefix <element name> is equivalent to the name of the node element in the response message to which the transmission request code applies.
| Transmission Request Code | Name | Description |
|---|---|---|
| 1 | Complete Structure | The node element and all its elements, its child node elements and all their elements will be returned. |
| 2 | Complete Node | The node element and all its elements will be returned. |
| 3 | Node with Key Elements | The node element and its key elements will be returned (not supported by all web service interfaces). |
| 4 | Excluded Node | The node element and its child node elements will not be returned. |
The transmission request code is optional. If no transmission request code is modeled or provided by the service consumer, then the following rules apply:
If no transmission request code is provided at all, then the response message contains all data.
If the transmission request code of the parent node element is 1, then its sub-node elements for which no transmission request code is specified are defaulted by 1.
If the transmission request code of the parent node element is 2 or 3, then its sub-node elements for which no transmission request code is specified are defaulted by 4.
If the transmission request code of the parent node element is 4, then its sub-node elements are not returned anyway.
The structure of the query response message consists of three parts:
A business document-specific part containing the returned business documents
Processing conditions
Log items containing system messages including errors, warnings, and information messages raised by the system during processing of the web service request.
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Possible scenarios include the following:
Find phone call Activity
With a certain name
With a certain party
Example to get all phone call activities with a certain subject name:
<n0:PhoneCallActivityByElementsQuery_Sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <PhoneCallActivitySelectionByElements> <SelectionByName> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryName>A2X*</LowerBoundaryName> <UpperBoundaryName></UpperBoundaryName> </SelectionByName> </PhoneCallActivitySelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>100</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:PhoneCallActivityByElementsQuery_Sync_V1>
Example to find phone call activites with a certain activity party:
<n0:PhoneCallActivityByElementsQuery_Sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <PhoneCallActivitySelectionByElements> <SelectionByActivityPartyBusinessPartnerInternalID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryInternalID>MC9785</LowerBoundaryInternalID> <UpperBoundaryInternalID></UpperBoundaryInternalID> </SelectionByActivityPartyBusinessPartnerInternalID> </PhoneCallActivitySelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>25</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:PhoneCallActivityByElementsQuery_Sync_V1>
| Description | Find phone call activities |
| Name | FindByElements |
| Synchronous | yes |
| Release Status | Released |
An interface to query phone call activity data.
FindByElements is an operation to query phone call activity data by the selection elements passed in the request.
A phone call activity should exist in the system in order to get a positive result.
| FindByElements | UI Element |
|---|---|
| SelectionByIdentifier | Phone call activity ID |
| SelectionByActivityPartyBusinessPartnerInternalID | Account ID |
| SelectionByName | Description |
| SelectionByCreatedDateTime | Created Date Time |
| SelectionByLastChangeDateTime | Last Change Date Time |
| SelectionByReportedDateTime | Reported Date Time |
| SelectionByBusinessPartnerInternalID | Party ID |
The inclusion/exclusion code (element name InclusionExclusionCode) specifies the inclusion or exclusion of a set into a result set.
| Inclusion Exclusion Code | Description |
|---|---|
| E | Excluding |
| I | Including |
The interval boundary type code (element name IntervalBoundaryTypeCode) is used to describe intervals by their boundaries. Depending on the operator, the lower boundary value or both boundary values are relevant.
| Interval Boundary Type Code | Name | Description | |
|---|---|---|---|
| 1 | Equal to | Single value | = X |
| 2 | Between (excluding upper boundary) | Interval with closed lower and open upper boundary | [X, Y) |
| 3 | Between | Interval with open lower and open upper boundary | (X, Y) |
| 4 | Between (excluding both boundaries) | Interval with open lower and open upper boundary | (X, Y) |
| 5 | Between (excluding lower boundary) | Interval with open lower and closed upper boundary | (X, Y] |
| 6 | Less than | Interval with unlimited lower and open upper boundary | < X |
| 7 | Less Than or Equal to | Interval with unlimited lower and closed upper boundary | <= X |
| 8 | Greater Than | Interval with open lower and unlimited upper boundary | > X |
| 9 | Greater Than or Equal to | Interval with closed lower and unlimited upper boundary | = X |
"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: 2012-11-27T15:30:00Z
| FindByElements | UI Element |
|---|---|
| QueryHitsMaximumNumberValue | Query Hits Maximum Number Value |
| QueryHitsUnlimitedIndicator | Query Hits Unlimited Indicator |
| LastReturnedObjectID | Last Returned Object ID |
The query processing conditions specify how to process a query with respect to the maximum number of hits to be returned.
Query request messages provide the following processing parameters:
Query hits maximum number value (element name QueryHitsMaximumNumberValue): Maximum number of hits to be returned by an inquiry.
Query hits unlimited indicator (element name QueryHitsUnlimitedIndicator): Indicates whether the maximum number of hits to be returned by an inquiry is unlimited or not.
Last returned object ID (element name LastReturnedObjectID): Identifies the last object returned by a previous inquiry.
Note: If QueryHitsUnlimitedIndicator = true, QueryHitsMaximumNumberValue must not be filled.
Query response messages provide the following elements:
Returned query hits number value (element name ReturnedQueryHitsNumberValue): The number of hits returned by an inquiry.
More hits available indicator (element name MoreHitsAvailableIndicator): Indicates whether there are more than ReturnedQueryHitsNumberValue hits matching the selection criteria or not.
Last returned object ID (element name LastReturnedObjectID): Identifies the last object returned by this inquiry.
Note: Processing conditions can be used for the paging of query results. However, it is crucial not to change the query selection parameters from request to request. Otherwise, the query result might change.
Requested elements (element name RequestedElements) enable web service consumer to reduce the size of query response messages. Therefore, transmission and response times are reduced, thus avoiding timeouts.
Requested elements contain transmission request codes for controlling the transmission of corresponding query response node elements.
The transmission request codes are modeled as xml attributes following the syntax: <element name>TransmissionRequestCode.
The prefix <element name> is equivalent to the name of the node element in the response message to which the transmission request code applies.
| Transmission Request Code | Name | Description |
|---|---|---|
| 1 | Complete Structure | The node element and all its elements, its child node elements and all their elements will be returned. |
| 2 | Complete Node | The node element and all its elements will be returned. |
| 3 | Node with Key Elements | The node element and its key elements will be returned (not supported by all web service interfaces). |
| 4 | Excluded Node | The node element and its child node elements will not be returned. |
The transmission request code is optional. If no transmission request code is modeled or provided by the service consumer, then the following rules apply:
If no transmission request code is provided at all, then the response message contains all data.
If the transmission request code of the parent node element is 1, then its sub-node elements for which no transmission request code is specified are defaulted by 1.
If the transmission request code of the parent node element is 2 or 3, then its sub-node elements for which no transmission request code is specified are defaulted by 4.
If the transmission request code of the parent node element is 4, then its sub-node elements are not returned anyway.
The structure of the query response message consists of three parts:
A business document-specific part containing the returned business documents
Processing conditions
Log items containing system messages including errors, warnings, and information messages raised by the system during processing of the web service request.
ID- The Phone call activity ID
UUID- The Unique identifier for Phone call activity
SystemAdministrativeData- Structure node
CreationDateTime- Document creation date time
CreationIdentityUUID- Unique identifier of the user who created the Phone call activity
LastChangeDateTime- Document last change date time
LastChangeIdentityUUID- Unique identifier of the user who recently changed the Phone call activity.
Name- Name of the Phone call activity
PriorityCode- Priority of the Phone call activity
| Code | Description |
|---|---|
| 1 | Immediate |
| 2 | Urgent |
| 3 | Normal |
| 7 | Low |
InitiatorCode- Direction of the Phone call activity
| Code | Description |
|---|---|
| 2 | Inbound |
| 3 | Outbound |
InformationSensitivityCode- Sensitivity level of the Phone call activity
| Code | Description |
|---|---|
| 1 | Normal |
| 2 | Personal |
| 3 | Private |
| 4 | Confidential |
GroupCode- Classification of the Phone call activity
| Code | Description |
|---|---|
| 0002 | Telephone call |
| 0009 | Marketing |
| 0012 | Sales call |
| 0013 | Customer complaint |
| 0014 | Customer request |
DataOriginTypeCode- Orgin of the Document
| Code | Description |
|---|---|
| 1 | Manual Data Entry |
| 2 | Groupware |
| 3 | Direct Mailing |
| 4 | Telephony |
LifeCycleStatusCode- Phone call activity life cycle status code
| Code | Description |
|---|---|
| 1 | Open |
| 2 | In Process |
| 3 | Completed |
| 4 | Cancelled |
StartDateTime- Phone call activity scheduled start date
EndDateTime- Phone call activity scheduled end date
CommunicationParty- Participant in the call
EmployeeResponsibleParty- Employee responsible party ID
MainActivityParty- Customer ID
ReferenceParty- Reference Party ID
ActivityUnitParty- Org Unit party ID
BusinessTransactionDocumentReference – Structure node
ID- Reference document ID
Type Code- Document type code
Role Code- Role of the reference document
Text- Details of any text stored
AttachmentFolder- Attachment to the Phone call activity
This is a sample request for a simple wild card query and to return only 30 phone call activities.
<n0:PhoneCallActivityByElementsQuery_Sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <PhoneCallActivitySelectionByElements> <SelectionByIdentifier> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>*</LowerBoundaryIdentifier> <UpperBoundaryIdentifier></UpperBoundaryIdentifier> </SelectionByIdentifier> </PhoneCallActivitySelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>30</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:PhoneCallActivityByElementsQuery_Sync_V1>
<n0:PhoneCallActivityByElementsQuery_Sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <PhoneCallActivitySelectionByElements> <SelectionByBusinessPartnerInternalID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryInternalID>MC9785</LowerBoundaryInternalID> <UpperBoundaryInternalID></UpperBoundaryInternalID> </SelectionByBusinessPartnerInternalID> </PhoneCallActivitySelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>100</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:PhoneCallActivityByElementsQuery_Sync_V1>
Show full documentation
Show full documentation