Changes

stoney core: Search Resource - REST API

733 bytes added, 13:11, 14 May 2014
/* Overview */
= Overview =
The search resource provides a full text search over all the available resources. The available resources are:* The main framework called [[:Category:stoney core|stoney core]] is responsible for shared functionality.* The [[:Category:Self-Service Modules|Self-Service Modules]] expand the initial stoney cloud functionality.
A search could look as follows:
* <code>https://api.example.com/v1/search?q=fluffy+dragon&entries=15</code>.
The following rules apply:* Minimum The minimum number of characters for the query are 3.* number Number of entries returned '''per''' object type:** defaultDefault: 5** max Maximum: 15 (can be raised by '''entries''' get parameter): 15* the The attributes returned for each individual resource are presently the same as when querying the corresponding resource collection. = stoney core: search resource methods =As described above, each resource has its own search methods. The current stoney core resources are:* [[stoney core: Resellers Resource - REST API]]* [[stoney core: Customers Resource - REST API]]* [[stoney core: People Resource - REST API]] The following special resources don't have additional search methods:* [[stoney core: Authentication Resource - REST API]]* [[stoney core: Search Resource - REST API]] == Resellers Search (GET) == == Customers Search (GET) == == People Search (GET) == 
Visit [[stoney core: Global Searches]] for the return values per resource.
TBD
* clarify number of entries (possibly rename?)
<source lang='javascript'>
SLB, editor, reviewer
3,368
edits