Contents: MashupHub API Reference : Mashup Center 2.0
The feed containing the results of an OpenSearch query consists of entries in formats defined by the individual plug-ins. The entry format for all system plug-ins (for example, plug-ins that ship with MashupHub) is specified in the following sections. Third-party plug-ins are free to format their OpenSearch results in any manner.
The OpenSearch feed supports paging through OpenSearch extension elements under the Atom <feed>
element. These are:
Defines the index of the first entry included in the OpenSearch feed. The index starts at 0. itemsPerPage
Defines the number of items included in the feed. totalResults
Defines the total number of results from the query. By default the OpenSearch feed starts with index 0 and include the first set of entries, according to the specified sort order, equal in number to itemsPerPage.
To page through a large result feed, use the startIndex
URL parameters on the OpenSearch query to specify the index and the number of entries to include.
A client should refer to the <category>
element in each entry to determine to what plug-in an entry belongs and how to interpret its content. A client should refer to the element name of the child element under the <content>
element to determine the collection to which an entry belongs.
The server uses <category>
to determine which collection plugin should handle the <entry>
. There are limitations:
- An entry may be categorized in one category only.
- For "human-readable" categorization of entries custom, categorization mechanism may be used in the XML body of <entry>.
Parent topic: Search API : Mashup Center 2.0