MembersAutocomplete

Summary

The Members Autocomplete API provides a list of Members filtered by a query. It is intended for fast-feedback as-you-type scenarios.

Status

Operation	Status
Autocomplete Members	200

Operations

Autocomplete Members

When autocompleting Members, the response will contain an array of Members that match the query across the start of firstname, lastname or email. Members are filtered by the Companies of which the authenticated Identity is a Member. Actor is an abbreviated Member resource.

The company id in the request does not alter the query or results however it will return a 403 if the id passed in is in a list of disabled companies defined in the website's web config. For example if a user belongs to companies 1,2 and company 2 is disabled.

|Request|Result| |/members/companies/1/autocomplete?q=bob|Returns a search result over members within companies 1 and 2| |/members/companies/2/autocomplete?q=bob|Returns a 403 response| |/members/companies/3/autocomplete?q=bob|Returns a search result over members within companies 1 and 2|

The API is hosted on its own website 'member'

Example

Request

GET /members/companies/{companyId}/autocomplete?q=isi&hits=10
Accept: application/vnd.huddle.data+xml (or+json)
Authorization: OAuth2 frootymcnooty/vonbootycherooty

Response

HTTP/1.1 200 OK
Content-Type: application/vnd.huddle.data+xml

<membersAutocomplete>
    <link rel="self" href="..." />
    <members>
        <actor rel="member" name="Isidore McHohenheim" email="[email protected]">
            <link rel="avatar" href="..." type="image/jpg" />
            <identity email="[email protected]" />
        </actor>
    </members>
</membersAutocomplete>

HTTP/1.1 200 OK
Content-Type: application/vnd.huddle.data+json

{
  "links": [
    { "rel": "self", "href": "..." }
  ],
  "members": [{
    "links": [
        { "rel": "avatar", "href" : "...", "type" : "..." }
    ],
    "name": "Isidore McHohenheim",
    "email": "[email protected]",
    "rel": "member",
    "identity": {
        "email": "[email protected]"
    }
  }]
}

Note: Unlike elsewhere in the API, the Actor links do not currently include self or alternate links.

Parameters

Name	Description	Methods	Optional
q	The query to complete on	GET	No
hits	The number of results to return. Defaults to 10. Max 20.	GET	Yes

Link relations

Name	Description	Methods
self	The URI of the resource	GET

Other Responses

Case	Response
q is empty or whitespaces	400 Bad request
Hits less than 1	400 Bad request
Hits more than 20	400 Bad request
POST, DELETE, PUT used	405 Method not allowed
Elastic Search is unavailable	503 Service unavailable
company id is in the list of disabled companies	403