stoney core: Search Resource - REST API

From stoney cloud
Revision as of 17:55, 29 January 2014 by Tiziano (Talk | contribs)


Jump to: navigation, search

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,
        "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"
  },
  ...
}