search (xml)

Handle calls to the search service
RESTful URLs: http://microformats.org/wiki/rest/urls
HTTP response codes as returned by the system:
200 - OK (request is ok and content returned)
201 - CREATED (request created new content, URL and id of content in the header)
204 - NO CONTENT (request is ok but no content to return)
400 - ERROR (general error in the request, probably invalid parameters or data)
401 - UNAUTHORIZED (user authentication required for this request)
403 - FORBIDDEN (authorization required, insufficient privileges, user is already authenticated)
404 - NOT FOUND (resource not found, URL is invalid in some way, id or action are invalid)
405 - METHOD NOT ALLOWED (the method is not supported for this entity type)
406 - NOT ACCEPTABLE (the data format requested is unavailable for this entity type)
500 - INTERNAL SERVER ERROR (general server failure, probably a failure in the provider)
501 - NOT IMPLEMENTED (indicates that a prefix is invalid)

Custom Actions

search : list (GET) : [/search/search] (json) (xml)
Search through the indexed content of sites where the current user is registered.Mandatory parameter: "searchTerms", search query. Optional parameter: "contexts", sites IDs where the search will be done (all sites for the current user by default). Optional parameter: "startIndex", list results starting from the startIndex (0 by default). Optional parameter: "startPage", use pagination instead of a startIndex. Optional parameter: "count", number of results to retrieve (10 by default).
tools : show (GET) : [/search/:ID:/tools] (json) (xml)
Get the list of every tool providing content to the search engine.

Data and Request Handling

Output formats : json, xml
Input formats : No formats allowed
No Access Provider registered for request processing

Capabilities

NameTypeDescription
1EntityProviderorg.sakaiproject.entitybroker.entityprovider.EntityProvider
2ActionsExecutableorg.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable
3Describeableorg.sakaiproject.entitybroker.entityprovider.capabilities.Describeable
4Outputableorg.sakaiproject.entitybroker.entityprovider.capabilities.Outputable

REST:: 1.0.1 SVN: $Revision$ : $Date$