Get Method

Fetches the document using the HTTP GET method.

Syntax

rest.get(URL, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method fetches the document using the HTTP GET method. The document contents are delivered to the component and parsed. The XPath, XElement, XText, etc. or the TransferredData property can then be used to traverse the data. The HTTP response headers are returned through the Header event. If LocalFile is not empty the data (not the headers) is written there as well.