Build
This function converts an object to an XML string.
Required fields are indicated by a red asterisk.
Input Fields
- object: object that will be converted into an XML string
- options
- rootName: name of the root element of the XML document
-
doctype: doctype of the XML document
- renderOptions
-
pretty: determines whether the XML document will be rendered into “pretty” style; options are True and False
-
indent: used when the pretty field is set to True; this value specifies the character(s) to use as indentation character(s) in the XML document
-
newline: used when the pretty field is set to True; this value specifies the character(s) to use as newline character(s) in the XML document
-
- declaration
-
version: determines the version that’s added to the XML declaration; default is
1.0
; common values are1.0
and1.1
, although any 1.x values are accepted -
encoding: adds a specified character encoding to the XML declaration; for example,
UTF-8
-
standalone: adds a standalone attribute to the XML declaration; if set to False, it adds the standalone attribute to the XML declaration as
standalone="no"
; if set to True, it adds the standalone attribute to the XML declaration asstandalone="yes"
-
Output Fields
- xml: the assembled XML document