ASI/search

GET ^top

Performs a fulltext search spanning people, channels, messages and groups. Results are sorted by relevance.

Parameters

page

Which page to show. Indexing starts at 1.

per_page

How many results to show per page.

search

The search term. Sensible results for search terms under the length of 2 are not guaranteed. Wildcards are supported; the search is by default a wildcard search from both sides.

Access

Client login

Returns

  • 200

Response example


{
  "pagination": {
    "size": 42,
    "page": 1,
    "per_page": 3
  },
  "entry": [
    {
      "result": {
        "name": {
          "unstructured": "Essi Esimerkki",
          "family_name": "Esimerkki",
          "given_name": "Essi"
        },
        "address": {
          "unstructured": "Yrjö-Koskisenkatu 42, 00170 Helsinki",
          "postal_code": "00170",
          "street_address": "Yrjö-Koskisenkatu 42",
          "locality": "Helsinki"
        },
        "birthdate": "1940-06-01",
        "updated_at": "2011-09-28T11:11:08Z",
        "is_association": null,
        "username": "kusti20",
        "id": "cqR9z46Cir4juJeJfcaj6R",
        "avatar": {
          "link": {
            "href": "/people/cqR9z46Cir4juJeJfcaj6R/@avatar",
            "rel": "self"
          },
          "status": "not_set"
        },
        "gender": "MALE",
        "msn_nick": "maison",
        "phone_number": "+358 40 834 7176",
        "website": "http://example.com",
        "irc_nick": "pelle",
        "description": "About me",
        "status": {
          "changed": "2011-09-28T11:11:08Z",
          "message": "Valid person rocks."
        }
      },
      "type": "Person"
    },
    {
      "result": {
        "number_of_members": 0,
        "created_at": null,
        "title": "An example group 10",
        "group_type": "open",
        "id": "cqSvbM6Cir4juJeJfcaj6R",
        "created_by": "cqSv5e6Cir4juJeJfcaj6R",
        "description": "Groups can have descriptions. This is an example."
      },
      "type": "Group"
    },
    {
      "result": {
        "name": "Chanel 9 3",
        "channel_type": null,
        "created_at": null,
        "updated_at": null,
        "owner_id": "cqTpPE6Cir4juJeJfcaj6R",
        "id": "cqToUq6Cir4juJeJfcaj6R",
        "message_count": 0,
        "owner_name": "Essi Esimerkki",
        "updated_by": {
          "name": "Essi Esimerkki",
          "link": {
            "href": "/people/cqTpPE6Cir4juJeJfcaj6R/@self"
          }
        },
        "description": "Hethethethethethe",
        "hidden": false
      },
      "type": "Channel"
    }
  ]
}