XMLReader

Provides functionality for working with XML-based data. When working with this object, if you are not getting the results expected, call removeNamespaces().

This class also used in (click to expand):

Method Summary
File	getFile(String xpath, String filename, String contentType) Locates text node by xpath expression and creates a File object for it. Content of node should be base64 encoded. File.isValid will indicate success of the operation
int	getResponseLength() Returns the length of the response body in bytes.
Data	readAllTextData(String xpath) Creates data object by evaluating xpath expression on response body from first matching element using all descendant elements' names as keys and text nodes as values. Fails if response body is not xml.
Data	readAttributeData(String xpath) Creates data object by evaluating xpath expression on response body using attributes of first matching element. Fails if response body is not xml
DataList	readAttributeDataList(String name, String xpath) Creates datalist object by evaluating xpath expression on response body using attributes of matching elements. Fails if response body is not xml
String	readBody() Reads the body of the response. Returns null if there is no body or the body exceeds the maximum upload allowed by the activation key.
String	readJSON() Reads the body of the response and converts it to JSON if it is XML. Returns null if there is no body or the body exceeds the maximum upload allowed by the activation key.
String	readNodeText(String xpath) Returns text of the first node selected by xpath expression. If node is an attribute then attribute value returned. If node is an element then element's text contents returned. Fails if response body is not xml
Data	readTextData(String xpath) Creates data object by evaluating xpath expression on response body from first matching element using children elements' names as keys and text nodes as values. Fails if response body is not xml.
DataList	readTextDataList(String name, String xpath) Creates datalist object by evaluating xpath expression on response body from matching elements using children elements' names as keys and text nodes as values. Fails if response body is not xml
	removeNamespaces() Removes namespaces from the payload XML so the content can be queried with XPATH.
	setEncoding(String encoding) Sets the encoding to be used for reading the payload
File	toFile(String fileName) Returns the content of this response as a File.

Method Detail

File getFile(String xpath, String filename, String contentType)

Locates text node by xpath expression and creates a File object for it. Content of node should be base64 encoded. File.isValid will indicate success of the operation

Parameters:

String xpath
String filename
String contentType

Returns: File

Since: 02-01-2010

top

int getResponseLength()

Returns the length of the response body in bytes.

Returns: int

Since: 01-20-2010

top

Data readAllTextData(String xpath)

Creates data object by evaluating xpath expression on response body from first matching element using all descendant elements' names as keys and text nodes as values. Fails if response body is not xml.

Parameters:

String xpath

Returns: Data

Since: 07-12-2011

top

Data readAttributeData(String xpath)

Creates data object by evaluating xpath expression on response body using attributes of first matching element. Fails if response body is not xml

Parameters:

String xpath

Returns: Data

Since: 12-22-2009

top

DataList readAttributeDataList(String name, String xpath)

Creates datalist object by evaluating xpath expression on response body using attributes of matching elements. Fails if response body is not xml

Parameters:

String name
String xpath

Returns: DataList

Since: 12-22-2009

top

String readBody()

Reads the body of the response. Returns null if there is no body or the body exceeds the maximum upload allowed by the activation key.

Returns: String

Since: 01-20-2010

top

String readJSON()

Reads the body of the response and converts it to JSON if it is XML. Returns null if there is no body or the body exceeds the maximum upload allowed by the activation key.

Returns: String

Since: 11-08-2016

top

String readNodeText(String xpath)

Returns text of the first node selected by xpath expression. If node is an attribute then attribute value returned. If node is an element then element's text contents returned. Fails if response body is not xml

Parameters:

String xpath

Returns: String

Since: 12-24-2009

top

Data readTextData(String xpath)

Creates data object by evaluating xpath expression on response body from first matching element using children elements' names as keys and text nodes as values. Fails if response body is not xml.

Parameters:

String xpath

Returns: Data

Since: 12-22-2009

top

DataList readTextDataList(String name, String xpath)

Creates datalist object by evaluating xpath expression on response body from matching elements using children elements' names as keys and text nodes as values. Fails if response body is not xml

Parameters:

String name
String xpath

Returns: DataList

Since: 12-22-2009

top

removeNamespaces()

Removes namespaces from the payload XML so the content can be queried with XPATH.

Since: 07-18-2018

top

setEncoding(String encoding)

Sets the encoding to be used for reading the payload

Parameters:

String encoding Required parameter. Allowed values: utf-8, iso-8859-1, utf-16, windows-1252.

Since: 03-05-2021

top

File toFile(String fileName)

Returns the content of this response as a File.

Parameters:

String fileName Required parameter.

Returns: File

Since: 06-25-2018

top

API Date: Nov 18, 2024 01:04 PM