AddXml (HttpRequest subroutine)
Add an XmlDoc to POST data for this request (HttpRequest class)
httpRequest:AddXml( doc, [options])
|httpRequest||A previously defined and instantiated HttpRequest object.|
|doc||A previously defined and instantiated XmlDoc object.|
|options||Any combination of the following options (but single occurrences only).
Note: These options are described in greater detail in "XmlDoc API serialization options".
- The XmlDoc that is passed is serialized into the post data of the request being built. It is not required that you serialize the XmlDoc first.
- Invoking this method erases any post data previously added by AddXml or AddLongstring method calls.
- If you do not explicitly set a content-type HTTP request header via AddHeader, AddXml generates a content-type header of "text/xml" upon a Post. To suppress this automatic header generation, you can set the AutoSendXmlContentType property to
- The options may be specified in any case, for example, you can use
- If one of the line-end (
CRLF) options or if
Indentis specified, and an element to be serialized has the
xml:space="preserve"attribute, then within the serialization of that element and its descendants, no line-end (nor indentation) characters are inserted to provide readability. Additionally, the
xml:space="default"attribute has no effect under these options. Specified by itself, it does not influence serialization, nor does it cause resumption of readability line-ends or indents if they were suspended by a containing
The following example shows the effect of the NoEmptyElt option:
begin %d is object xmlDoc %d = new %htr is object httpRequest %htr = new %sl is object stringlist %sl = new text to %sl <top p:abc="p" q:xyz="q" xmlns:p="urn:p" xmlns:q="http://q.com" name="t" id="z15" /> end text %d:loadXml(%sl) %htr:addXml(%d, 'NoEmptyElt') print %d:Serial(, 'EBCDIC NoEmptyElt') end
The print statement above (which uses the Janus SOAP XmlDoc API Serial method) displays the resulting XmlDoc content added to the HttpRequest object (formatted with some newlines for the sake of instruction):
<top xmlns:p="urn:p" xmlns:q="http://q.com" p:abc="p" q:xyz="q" name="t" id="z15"> </top>
NoEmptyElt produces an STag (
<top ...>) and an ETag (
</top>) for an empty element, rather than just the EmptyElemTag (
- For additional discussion about serialization, see Transport: receiving and sending XML.
- Additional non-HttpRequest serializing methods include: