Difference between revisions of "stoney core: Search Resource - REST API"

From stoney cloud
Jump to: navigation, search
[unchecked revision][unchecked revision]
Line 10: Line 10:
 
Vist [[stoney core: Global Searches]] for the return values per resource.
 
Vist [[stoney core: Global Searches]] for the return values per resource.
  
−
TBD: Update collection resource. Both resources should return the same values.
+
TBD:
 +
* Update collection resource. Both resources should return the same values.
 +
* clarify number of entries (possibly rename?)
  
 
<source lang='javascript'>
 
<source lang='javascript'>

Revision as of 14:39, 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.
  • 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"
  },
  ...
}
Retrieved from "http://wiki.stoney-cloud.org/mediawiki/index.php?title=stoney_core:_Search_Resource_-_REST_API&oldid=2818"