Action: RemoveNode

Purpose: Removes a Node and its sub-tree from a DOM.

More formally stated, this Action detaches a Node and its complete sub-tree of child nodes from its original location in the DOM tree and optionally deletes it from the DOM. If not deleted, the Node is left in the DOM Document but it is left unattached to the main Document tree.

This is an important Action, very commonly used when transforming XML Documents. This is because, provided the Node is not deleted from the DOM, the detached Node can be re-attached (along with its sub-tree) into another location in the DOM tree. The AppendChild and InsertBefore Actions are used to re-attach Nodes.

This Action may be applied to any Node Type.

Action-specific name/value pairs:

Parameter Name Description
NodeOID The Node to be removed
DeleteFromDOM (optional; default=false) If present, this parameter should be true or false. If true, the Node and its entire sub-tree of Child Nodes is permanently deleted from the Document.

By default, removal of the Node leaves it in the Document but detached from the Document tree.

Alternatively, the parameters above can be incorporated into a single JSON string and specified using the parameter name JSON, eg:

{NodeOID:"1-3",DeleteFromDOM:true}

Example Request

Action=RemoveNode
&DeleteFromDOM=false
&MDBAccessKeyId=[your access key id]
&NodeOID=1-3
&Signature=[computed signature]
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2009-06-14T13%3A19%3A41
&Version=2009-04-15
&db=mdbx

or:

Action=RemoveNode
&JSON=%7BNodeOID%3A%221-3%22%2CDeleteFromDOM%3Atrue%7D
&MDBAccessKeyId=[your access key id]
&OutputFormat=JSON
&Signature=[computed signature]
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2009-06-14T13%3A19%3A41
&Version=2009-04-15
&db=mdbx

Example Response

XML

<?xml version='1.0'?>
<RemoveNodeResponse xmlns="http://mdbx.mgateway.com/doc/2009-06-05/" />

JSON (ie if OutputFormat=JSON specified in the Request)

{ok:true}