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	Beta

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, with the self link pointing to the full Member resource.

Example

Request

GET /members/autocomplete?q=isi
Content-Type: application/vnd.huddle.data+xml (or+json)

Response

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

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

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