Definition
An interface to query service confirmations.
Business Context and Use
This web service is used to query service confirmations.
It has the FindByElements operation which is used to query for one or more instances of the service confirmation based on the query filter parameters passed.
Prerequisites
A service confirmations should exist in the system in order to get a positive result.
Constraints and Integrity Conditions
General Rules for Using this Web Service
UUIDs / TechnicalIDs
For certain nodes with cardinality from 0 - *, the UUID / TechnicalIDs are used as identifier for each of the respective nodes.
Processing Conditions
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>
Requested Elements
The query normally returns information for all the nodes present in the response structure, as long as the respective service confirmation(s) has content for those nodes. But with the RequestedElements node, a consumer can request a specific child node of the root ServiceConfirmation node.
The attribute ServiceConfirmationTransmissionRequestCode of RequestedElements node is a coded representation of the elements that are requested for transmission.
| Code Value |
Description |
|---|
| 1 |
Complete Structure |
| 2 |
Complete Node |
| 3 |
Node with Key Elements |
| 4 |
Excluded Node |
Example
<RequestedElements ServiceConfirmationTransmissionRequestCode="2">
<ServiceConfirmation itemTransmissionRequestCode="2"
itemOverviewTransmissionRequestCode="2"
textCollectionTransmissionRequestCode="2"
attachmentFolderTransmissionRequestCode="2">String 246</ServiceConfirmation>
</RequestedElements>
More Information
General Information
You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.
Definition
To query service confirmations by elements.
Business Context and Use
FindByElements is an operation to query service confirmation data by the selections elements passed in the request.
Structure
Request
Below are the list of selection elements available and their corresponding business context with the UI:
| SelectionByElements |
UI Element |
|---|
| SelectionById |
Service Confirmation ID |
| SelectionByUUID |
<None> |
Mandatory Fields
Response
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.
Example
Example to query Service Confirmations based on ID:
<n0:ServiceConfirmationByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<ServiceConfirmationSelectionByElements>
<SelectionByID>71</SelectionByID>
</ServiceConfirmationSelectionByElements>
</n0:ServiceConfirmationByElementsQuery_sync>
Response
<nm:ServiceConfirmationByElementsResponse_sync
xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:HXM
:/1SAI/TAS25A1C3A40B51EDB4546F:803">
<ServiceConfirmation>
<ChangeStateID>20120208081022.2168480</ChangeStateID>
<UUID>00163e04-f8f7-1ed3-85d7-8baac9427ad1</UUID>
<ID>71</ID>
<BuyerID>T</BuyerID>
<TypeCode>T</TypeCode>
<TypeName>T</TypeName>
<Name>T</Name>
<Status/>
<BusinessTransactionDocumentReference/>
<IncidentServiceIssueCategory/>
<ServicePointLocation/>
<ServicePerformerParty/>
<BuyerParty/>
<SalesTerms/>
<ServiceReferenceObject/>
<ServiceTerms/>
<IncidentCompletionTimePointTimePointTerms/>
<ActualArrivalAtCustomerTimePointTerms/>
<AttachmentFolder/>
<TextCollection/>
<Item/>
<ItemOverview/>
</ServiceConfirmation>
<ProcessingConditions/>
<Log/>
</nm:ServiceConfirmationByElementsResponse_sync>
Show full documentation
Show full documentation