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

From stoney cloud
Jump to: navigation, search
[unchecked revision][unchecked revision]
(→‎Search helper)
Line 7: Line 7:
 
** default: 5
 
** default: 5
 
** max (can be raised by appropriate get parameters): 15
 
** max (can be raised by appropriate get parameters): 15
 +
 +
Vist [[stoney_core:_Global_Searches]] for the return values per resource.
 +
 +
TBD: Update collection resource. Both resources should return the same values.
  
 
<source lang='javascript'>
 
<source lang='javascript'>
Line 14: Line 18:
 
     "resources":
 
     "resources":
 
     [
 
     [
−
       { "id": 4000000, ... },
+
       { "id": 4000000,
 +
        "organization": gugug. ltd.,
 +
        ... , 
 +
        "location": "https://api.selfcare.com/v1/resellers/4000000"  },
 
       { "id": 4000001, ... }
 
       { "id": 4000001, ... }
 
     ],
 
     ],

Revision as of 17:47, 9 January 2014

The search resource provides a full text search over all the available resources.

  • Minimum number of characters are 3.
  • number of entries returned per object type:
    • default: 5
    • max (can be raised by appropriate get parameters): 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": gugug. 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=2716"