Page last modified 21:04, 26 Jul 2010 by arnec
MindTouch Community Portal > MindTouch Community Portal > Reference > MindTouch API > GET:site/opensearch
Table of contents
- 1. Overview
- 1.1.1.1. Uri Parameters
- 1.1.1.2. Query Parameters
- 1.1.1.3. Return Codes
- 2. Message Format
- 3. Implementation Notes
- 4. Code Samples
- 4.1. C# Samples
- 4.2. Curl Samples
- 4.3. PHP Samples
- 4.4. Other Code Samples
Overview
public. Search the site index
Uri Parameters
None
Query Parameters
| Name | Type | Description |
| authenticate | bool? | Force authentication for request (default: false) |
| constraint | string? | Additional search constraint (ex: language:en-us AND type:wiki) default: none |
| format | {rss | atom}? | search output format (rss | atom) default: atom |
| limit | string? | Maximum number of items to retrieve. Must be a positive number or 'all' to retrieve all items. (default: 100) |
| nocache | bool? | Use caching search path (better for paging results) (default: false) |
| offset | int? | Number of items to skip. Must be a positive number or 0 to not skip any. (default: 0) |
| parser | {bestguess|term|filename|lucene}? | The parser to use for the query (default: bestguess) |
| q | string | lucene search string |
| sortby | {score, title, date, size, wordcount, rating.score, rating.count}? | Sort field. Prefix value with '-' to sort descending. default: -score |
Return Codes
| Name | Value | Description |
| BadRequest | 400 | Invalid input parameter or request body |
| Ok | 200 | The request completed successfully |
Message Format
Output (RSS):
<rss version="2.0">
<channel>
<title>{text}</title>
<description>{text}</description>
<opensearch:totalResults>{int}</opensearch:totalResults>
<opensearch:itemsPerPage>{int}</opensearch:itemsPerPage>
<opensearch:Query role="request" searchTerms="{text}" startPage="{int}" />
<atom:link rel="{alternate|search|first|next|last|self}" type="{contenttype}" href="{uri}" />
...
<item>
<title>{text}</title>
<link>{uri}</link>
<description>{text}</description>
<relevance:score>{int}</relevance:score>
<dekilucene:size>{int}</dekilucene:size>
<dekilucene:wordcount>{int}</dekilucene:wordcount>
<dekilucene:path>{text}</dekilucene:path>
<dekilucene:page.parent id="{int}" path="{text}" title="{text}" href="{uri}" />
</item>
...
</channel>
</rss>
Output (Atom):
<feed>
<generator version="{text}">{text}</generator>
<updated>{date}</updated>
<title type="{text}">{text}</title>
<author>
<name>{text}</name>
</author>
<id>{uri}</id>
<opensearch:totalResults>{int}</opensearch:totalResults>
<opensearch:itemsPerPage>{int}</opensearch:itemsPerPage>
<opensearch:Query role="request" searchTerms="{text}" startPage="{int}"/>
<link rel="{alternate|search|first|next|last|self}" type="{contenttype}" href="{uri}" />
...
<entry>
<title type="text">{text}</title>
<published>{date}</published>
<updated>{date}</updated>
<link href="{uri}" />
<id>{uri}</id>
<content type="text">{text}</content>
<relevance:score>{int}</relevance:score>
<dekilucene:size>{int}</dekilucene:size>
<dekilucene:wordcount>{int}</dekilucene:wordcount>
<dekilucene:path>{text}</dekilucene:path>
<dekilucene:page.parent id="{int}" path="{text}" title="{text}" href="{uri}" />
</entry>
...
</feed>
Implementation Notes
Refer here for more information on the Lucene search string format.
Refer here for more information about OpenSearch.
Code Samples
C# Samples
Curl Samples
PHP Samples
Other Code Samples
- Was this page helpful?
- Tag page
- What links here
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
You must login to post a comment.
Copyright © 2011 MindTouch, Inc. Powered by