GetSearchPage API¶

Returns the full definition of a single search page by ID, including its field-visibility configuration.

Endpoint¶

/srv.asmx/GetSearchPage

Methods¶

GET /srv.asmx/GetSearchPage?authenticationTicket=...&searchPageId=...
POST /srv.asmx/GetSearchPage (form data)
SOAP Action: http://tempuri.org/GetSearchPage

Parameters¶

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`
`searchPageId`	int	Yes	ID of the search page to retrieve. Obtain IDs from `GetSearchPages`

Response¶

Success¶

<root success="true">
  <SearchPage id="47" name="Contract Search" description="Search for contract documents"
              ownerId="0" anonymousAccess="false" publicAccess="true" userGroupIds="12,34">
    <searchParametersXml><![CDATA[<SEARCH>
  <ITEM NAME="SEARCHFOR" VALUE="" VISIBLE="TRUE" />
  <ITEM NAME="KEYWORDS" VALUE="" VISIBLE="TRUE" />
  <ITEM NAME="DOCUMENTNAME" VALUE="" VISIBLE="FALSE" />
  ...
</SEARCH>]]></searchParametersXml>
  </SearchPage>
</root>

Error¶

<root success="false" error="Error message here" />

Response Fields¶

`SearchPage` attributes¶

Attribute	Type	Description
`id`	int	Search page ID
`name`	string	Display name
`description`	string	Optional description
`ownerId`	int	`0` = system-wide page; `> 0` = private page owned by that user ID
`anonymousAccess`	bool	Whether anonymous users can access this page. Always `false` for personal pages
`publicAccess`	bool	Whether all authenticated users can access this page. Always `false` for personal pages
`userGroupIds`	string	Comma-separated group IDs that have explicit access. Empty = no group restriction. Always empty for personal pages

`searchParametersXml` child element¶

Contains a CDATA section with the field-visibility XML. The format is identical to the searchParametersXml parameter accepted by SaveSearchPage. Each <ITEM> element defines one search field:

<SEARCH>
  <ITEM NAME="SEARCHFOR" VALUE="" VISIBLE="TRUE" />
  <ITEM NAME="KEYWORDS" VALUE="" VISIBLE="FALSE" />
  ...
</SEARCH>

Pass this XML directly to SaveSearchPage.searchParametersXml to clone or update the search page configuration.

Required Permissions¶

User must be authenticated.

Example Requests¶

Request (GET)¶

GET /srv.asmx/GetSearchPage?authenticationTicket=abc123&searchPageId=47 HTTP/1.1

Request (POST)¶

POST /srv.asmx/GetSearchPage HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=abc123&searchPageId=47

Request (SOAP 1.1)¶

POST /srv.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/GetSearchPage"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSearchPage xmlns="http://tempuri.org/">
      <authenticationTicket>abc123</authenticationTicket>
      <searchPageId>47</searchPageId>
    </GetSearchPage>
  </soap:Body>
</soap:Envelope>

Error Codes¶

Error	Description
`[901] Session expired or Invalid ticket`	Invalid or expired authentication ticket
`[3169] ...`	Search page not found

Notes¶

Use GetSearchPages first to discover available search page IDs.
The searchParametersXml output can be modified and passed back to SaveSearchPage to create a variant of an existing page.
userGroupIds contains numeric IDs. To resolve group names, use the user group management APIs.

GetSearchPages — List all search page definitions visible to the current user
SaveSearchPage — Create or update a search page definition
DeleteSearchPage — Delete a saved search page by ID