GetSearchOptions

Privileges. This method requires Read privileges.

Parameters.

The parameters for the GetSearchOptions method are described in the following table.

Parameter	Data Type	Value
sessionToken	String	Valid sessionToken returned by the general.CreateUserSession method.
searchReportId	Integer	The ID number of the report for which you are searching. Important: Statistics reports are not supported.

Output. This method returns a string. The value is an XML string that can be used as the searchOptions parameter in search.ExecuteSearch. If there is an error, the returned value will either be “NULL”, or an empty string.

Sample C# Call

sSearchXML = search.GetSearchOptions(sessionToken, iId);

Sample Request

The following is a sample SOAP 1.1 request and response. The placeholders shown would be replaced with actual values. SOAP 1.2 also is supported.

POST /archer/ws/search.asmx HTTP/1.1

Host: eng-build02

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://archer-tech.com/webservices/GetSearchOptions"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<GetSearchOptions xmlns="http://archer-tech.com/webservices/">

<sessionToken>string</sessionToken>

<searchReportId>int</searchReportId>

</GetSearchOptions>

</soap:Body>

</soap:Envelope>

Sample Response

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<GetSearchOptionsResponse xmlns="http://archer-tech.com/webservices/">

<GetSearchOptionsResult>string</GetSearchOptionsResult>

</GetSearchOptionsResponse>

</soap:Body>

</soap:Envelope>