Definition
An interface to read monitoring information about rejected web service calls.
Business Context and Use
The web service interface Read Business Document Monitoring Information In enables you to connect external applications to your solution and to read monitoring information about rejected web service calls in your system. The web service interface Read Business Document Monitoring Information In is relevant if your company or an external partner want to connect an external application to your system. Sometimes web service calls are rejected, and monitoring information about the cause needs to be provided.
Here is an example of a simple web service request reading monitoring information that is persisted in the system using a given transaction ID and a timestamp.
<BusinessCommunicationMonitoringInformationByID>
<TransactionIDReference>00163E028B321ED2A8846018FBF78F31</TransactionIDReference>
<LogItemCreationDateTime>2013-04-08T08:04:59Z</LogItemCreationDateTime>
</BusinessCommunicationMonitoringInformationByID>
Prerequisites
The web service interface Read Business Document Monitoring Information In only returns monitoring information if the requesting user and the one who triggered the rejected web service call are identical.
Constraints and Integrity Conditions
Processing conditions
The read operation is a stateless synchronous web service operation.
Request Message
The request message provides two request parameters to read the monitoring information.
Response Message
The structure of the read response message consists of two parts:
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 read monitoring information for rejected web service calls.
Structure
Request Message
The request message provides the following request parameters:
TransactionIDReference: Transaction ID as returned during rejected web service calls.
This is mandatory information.
LogItemCreationDateTime: Timestamp as returned during rejected web service calls.
This is optional information.
Response Message
The response contains the communication monitoring information and log items.
Communication Monitoring Information
In this node, all found communication monitoring information is contained according to the request parameter provided in the request.
The following parameers will be returned:
TransactionID: Transaction ID as provided in the request message
Status: Status of the persisted monitoring information:
The following status codes can be returned within the response message:
| Status code |
Description |
|---|
| 5 |
Error in content of the web service call |
| 6 |
Technical error during the web service call |
| CommunicationDirection |
Description |
|---|
| 1 |
Inbound web service call |
| SeverityCode |
Description |
|---|
| E |
Error |
Show full documentation
Show full documentation