Difference between revisions of "stoney core: Search Resource - REST API"
From stoney cloud
[unchecked revision] | [unchecked revision] |
Line 3: | Line 3: | ||
* <code>https://api.example.com/v1/search?q=fluffy+dragon&entries=15</code>. | * <code>https://api.example.com/v1/search?q=fluffy+dragon&entries=15</code>. | ||
− | * Minimum number of characters are 3. | + | * Minimum number of characters for the query are 3. |
* number of entries returned '''per''' object type: | * number of entries returned '''per''' object type: | ||
** default: 5 | ** default: 5 |
Revision as of 14:36, 16 January 2014
The search resource provides a full text search over all the available resources.
- Minimum number of characters for the query are 3.
- number of entries returned per object type:
- default: 5
- max (can be raised by entries get parameter): 15
Vist stoney core: Global Searches for the return values per resource.
TBD: Update collection resource. Both resources should return the same values.
{ "resellers": { "resources": [ { "id": 4000000, "organization": "Reseller ltd.", ... , "location": "https://api.selfcare.com/v1/resellers/4000000" }, { "id": 4000001, ... } ], "location": "https://api.selfcare.com/v1/resellers/?q=fluffy+dragon" }, "customers": { "resources": [ { "id": 5000000, ... }, { "id": 5000001, ... } ], "location": "https://api.selfcare.com/v1/customers/?q=fluffy+dragon" }, ... }