alert-list-xml

Synopsis

nodeset alert-list-xml

Parameters

• Function takes no parameters.

Return Value

• nodeset - An xml node containing a list of alerts.

Exceptions

• alert-list - Thrown when there is an error retrieving the list of alerts.

Authentication

Like all Watson Explorer Engine API functions with the exception of ping, the alert-list-xml function requires authentication.

When using REST, you can simply pass v.username and v.password as CGI parameters via HTTP or HTTPS to authenticate the REST call to the alert-list-xml function.

When using the SOAP API, you can pass credentials as parameters on an endpoint, or you can leverage the authentication method that is supported by all Watson Explorer Engine functions. Each provides a setAuthentication method that can be passed an authentication object to provide the username and password under which a function executes. An example of this in Java for a SOAP call to the alert-list-xml function is the following:

    Authentication authentication = new Authentication();
    authentication.setUsername("joe-user");
    authentication.setPassword("joes-password");

    AlertListXml foo = new AlertListXml();
    foo.setAuthentication(authentication);

A single authentication object would typically be reused throughout each individual application.