Difference between revisions of "stoney core: Search Resource - REST API"
From stoney cloud
| [unchecked revision] | [unchecked revision] |
| Line 21: | Line 21: | ||
[ | [ | ||
{ "id": 4000000, | { "id": 4000000, | ||
| − | + | "location": "https://api.example.com/v1/resellers/4000000", | |
| − | + | "isCompany": true, | |
| − | "location": "https://api. | + | "isActive": true, |
| + | "resellerName": "Example Reseller Ltd" | ||
}, | }, | ||
| − | { "id": 4000001, .. | + | { "id": 4000001, |
| + | "location": "https://api.example.com/v1/resellers/4000001", | ||
| + | "isCompany": true, | ||
| + | "isActive": true, | ||
| + | "resellerName": "Example Reseller No 2 Ltd" | ||
| + | } | ||
], | ], | ||
| − | "location": "https://api. | + | "location": "https://api.example.com/v1/resellers/?q=example" |
}, | }, | ||
"customers": | "customers": | ||
| Line 33: | Line 39: | ||
"resources": | "resources": | ||
[ | [ | ||
| − | { "id": 5000000, .. | + | { "id": 5000000, |
| + | "location": "https://api.example.com/v1/customers/5000000", | ||
| + | "isCompany": true, | ||
| + | "isActive": true, | ||
| + | "customerName": "Example Customer Ltd" | ||
| + | }, | ||
{ "id": 5000001, ... } | { "id": 5000001, ... } | ||
], | ], | ||
| − | "location": "https://api. | + | "location": "https://api.example.com/v1/customers/?q=example" |
}, | }, | ||
... | ... | ||
Revision as of 13:44, 28 April 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
- the attributes returned for each individual resource are presently the same as when querying the corresponding resource collection
Visit stoney core: Global Searches for the return values per resource.
TBD
- clarify number of entries (possibly rename?)
{ "resellers": { "resources": [ { "id": 4000000, "location": "https://api.example.com/v1/resellers/4000000", "isCompany": true, "isActive": true, "resellerName": "Example Reseller Ltd" }, { "id": 4000001, "location": "https://api.example.com/v1/resellers/4000001", "isCompany": true, "isActive": true, "resellerName": "Example Reseller No 2 Ltd" } ], "location": "https://api.example.com/v1/resellers/?q=example" }, "customers": { "resources": [ { "id": 5000000, "location": "https://api.example.com/v1/customers/5000000", "isCompany": true, "isActive": true, "customerName": "Example Customer Ltd" }, { "id": 5000001, ... } ], "location": "https://api.example.com/v1/customers/?q=example" }, ... }
