GetXAttribute Method

Retrieve the value at the specified XPath in the SOAP response.

Syntax

sharepoint.getXAttribute(xpath, [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, data){ }

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

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The GetXAttribute method allows you to access a specific part of the SOAP response, through XPath.

For instance, to obtain the title of the first subsite, you could do the following:

SPSite.listSubSites();
Print SPSite.getXAttribute("/soap:Envelope/soap:Body/GetWebCollectionResponse/GetWebCollectionResult/Webs/Web[1]/@Title");

The contents of the SOAP response can be retrieved through the SOAPResponse configuration setting.