OpenSearch - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service allows users to get the OpenSearch description document of a Fluid Topics portal, if the OpenSearch integration is enabled.

Method Endpoint
GET 
/opensearch.xml

This web service requires authentication on portals with mandatory authentication

Response body

The following lines show an example of an XML response body:

<?xml version="1.0" ?>
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
  <ShortName>doc.fluidtopics.com</ShortName>
  <Description>This example must be edited in order to reflect your own engine</Description>
  <Url type="text/html" rel="results" template="https://doc.fluidtopics.com/search/all?query={searchTerms}"/>
  <Url type="application/atom+xml" rel="results" template="https://doc.fluidtopics.com/api/opensearch?query={searchTerms}&amp;limit={count?}&amp;startIndex={startIndex?}&amp;content-lang={language?}"/>
  <Query role="example" searchTerms="how"/>
</OpenSearchDescription>

The list of possible elements and their description is available in the OpenSearch specification.

Return code Description
200 OK The web service returns the OpenSearch description document of a portal.
404 OK The OpenSearch integration of the portal is disabled.