DeleteSavedSearch API¶

Deletes a saved search or search page definition by ID.

Endpoint¶

/srv.asmx/DeleteSavedSearch

Methods¶

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

Parameters¶

Response¶

Success¶

<response success="true" error="" />

Error¶

<response success="false" error="Access denied. Only search administrators can perform this operation." errorcode="4030" />

Required Permissions¶

• User must be authenticated.
• Personal entries: the owner only. Up to 8.7 a search administrator could delete anyone's personal entry, which they can neither read nor update.
• System-wide entries: members of the [Search & Category Administrators] role group, and administrators.

Example Requests¶

Request (GET)¶

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

Request (POST)¶

POST /srv.asmx/DeleteSavedSearch 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/DeleteSavedSearch"

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

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

Deletes a saved search.

await call('DeleteSavedSearch', { authenticationTicket: ticket, searchPageId: 20800 });

Deleting one that is not there is 4041, so the call is not idempotent - unlike most of the delete operations in this API.

Notes¶

• The default system search page (ID 1, "Advanced Search") is protected and cannot be deleted by anyone.
• Use GetSavedSearches to discover the IDs of available entries.

Related APIs¶

• GetSavedSearches — List all saved searches and search page definitions visible to the current user
• CreateSavedSearch — Create a new saved search or search page definition
• UpdateSavedSearch — Update an existing saved search or search page definition

Error Codes¶

The errorCode values this operation returns, checked against a running server: