ReSTful Web Services: Expected Output XML
If the output handler HTTP-MetaXml
has been defined for the respective URI operation within the web service configuration file, the webservice interface expects an XML document with the following structure as result from the process:
<Response>
<Status code="HTTP-Status-Code"/>
<Headers>
<Header>
<Name>HTTP Header name</Name>
<Value>Header value</Value>
</Header>
<!-- Or for date values: -->
<Header>
<Name>HTTP Header name</Name>
<Date timezone="Timezone">Header date value</Date>
</Header>
</Headers>
<Content encoding="Data encoding">Submitted data</Content>
</Response>
The root element <Response>
contains the following elements:
<Status>
: Contains in its attributecode
a three-digit number with the HTTP status code (e. g.202
).<Headers>
: Contains any number of<Header>
elements with HTTP header information. Each<Header>
element contains an HTTP header, which is defined via the child elements<Name>
and<Value>
or<Date>
(for date values in the formatyyyy-MM-dd HH:mm:ss
according to SimpleDateFormat). For the element<Date>
, an optional attributetimezone
can specify a timezone.<Content>
(optional): Contains within the attributeencoding
the encoding type (base64
orbase16
respectivelyhex
) and as element content the correspondingly encoded data and/or the stream elements.XML<Content encoding="base64"> ... Base64... <Stream url="http://remote.host/Some/Document?id=foo" transcoding="base64-us-ascii"/> ... mehr Base64... </Content>