Common Structure of Request and Response Documents
To ensure a standardized exchange of business management data the overall structure of request and response documents is the same regardless of which interface type is called. Generally three different types of business documents can be distinguished:
Request business documents that are identified by a root element that has the same name as the corresponding interface.
Example:
<doc:InterfaceName xmlns:doc="urn:…">
<!-- request specific data -->
…
</doc:InterfaceName>
Response business documents that are sent back from the server if the request has been correctly executed. They are identified by a root element that has the concatenation of the interface name and the suffix
.Response as its name.
Example:
<doc:InterfaceName.Response xmlns:doc="urn:…">
<!-- response specific data -->
…
</doc:InterfaceName.Response>
Exception business documents that are sent back from the server if application errors occurred during the execution of the request. They are identified by a root element that carries the concatenation of the interface name and the suffix
.Exception as its name.
Example:
<doc:InterfaceName.Exception xmlns:doc="urn:…">
<!-- exception specific data -->
…
</doc:InterfaceName.Exception>