Revision as of 15:45, 14 May 2014

Also visit stoney core: Search Resource Mapping (REST - LDAP) and stoney core: Global Searches.

Overview

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

• The main framework called stoney core is responsible for shared functionality.
• The Self-Service Modules expand the initial stoney cloud functionality.

A search could look as follows:

• https://api.example.com/v1/search?q=fluffy+dragon&entries=15.

The following rules apply:

• The minimum number of characters for the query are 3.
• Number of entries returned per object type:
  • Default: 5
  • Maximum: 15 (can be raised by entries get parameter)
• The attributes returned for each individual resource are presently the same as when querying the corresponding resource collection.

stoney core: search resource methods

As described above, each resource has its own search methods. The current stoney core resources are:

• stoney core: Resellers Resource - REST API
• stoney core: Customers Resource - REST API
• stoney core: People Resource - REST API

The following special resources don't have additional search methods:

• stoney core: Authentication Resource - REST API

Global Search (GET)

To form a global fulltext search (over all resources), append the url query parameter q with the desired search text: https://api.example.com/v1/search?q=example.

Global Search Request Message

GET <Request-URI> HTTP 1.1
HOST: <Host>

GET /v1/search?q=example HTTP 1.1
HOST: api.example.com 

Accept: <Type>/<Subtype>
Accept-Charset: <Charset>

Accept: application/json
Accept-Charset: UTF-8

Global Search Request Response Message

HTTP/1.1 <HTTP-Status-Code> <HTTP-Status-Message>

HTTP/1.1 200 OK

Content-Type: <Type>/<Subtype>; charset=<Charset>
Location: <Location-URI>
Link:
X-Total-Count:

Content-Type: Content-Type: application/json; charset=UTF-8

{ ... }

Resellers Search (GET)

Customers Search (GET)

People Search (GET)

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