POST api/v2.0/Contacts/SearchContactsForMentions?searchText={searchText}&maxCount={maxCount}

Provides Contact search results to be used for adding @Mention functionality to Content.

Request Information

URI Parameters

Name	Description	Type	Additional information
searchText	Requires a minimum of 3 characters to perform a search.	string	Required
maxCount	Number of results to return. If not included, will default to 10 results.	integer	Default value is 10

Body Parameters

None.

Response Information

Resource Description

Contact search result fields, including the markup necessary to include an @Mention of a given contact.

Collection of ContactMentionSearchResult

Name	Description	Type	Additional information
LinkToProfile	Url link to this Contact's Profile page in the Community site.	string	None.
PictureUrl	Url link to this Contact's small Profile Picture.	string	None.
ContactKey	Unique Identifier for this Contact.	globally unique identifier	None.
DisplayName	Calculated Display name.	string	None.
EmailAddress	Contact's email address.	string	None.
IsMentionable	True only if this Contact can be used in an @mention.	boolean	None.
ContactMentionMarkup	Provides the markup that can be added to the text of a Discussion Post to automatically add an @Mention for this Contact. Will be returned as an empty string if this result cannot be mentioned (IsMentionable will also be false).	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "87fd610c-480f-4dc0-8122-87b4687acdb7",
    "DisplayName": "sample string 4",
    "EmailAddress": "sample string 5",
    "IsMentionable": true,
    "ContactMentionMarkup": "sample string 7"
  },
  {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "87fd610c-480f-4dc0-8122-87b4687acdb7",
    "DisplayName": "sample string 4",
    "EmailAddress": "sample string 5",
    "IsMentionable": true,
    "ContactMentionMarkup": "sample string 7"
  }
]

application/xml, text/xml

Sample:

<ArrayOfContactMentionSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise">
  <ContactMentionSearchResult>
    <ContactKey>87fd610c-480f-4dc0-8122-87b4687acdb7</ContactKey>
    <ContactMentionMarkup>sample string 7</ContactMentionMarkup>
    <DisplayName>sample string 4</DisplayName>
    <EmailAddress>sample string 5</EmailAddress>
    <IsMentionable>true</IsMentionable>
    <LinkToProfile>sample string 1</LinkToProfile>
    <PictureUrl>sample string 2</PictureUrl>
  </ContactMentionSearchResult>
  <ContactMentionSearchResult>
    <ContactKey>87fd610c-480f-4dc0-8122-87b4687acdb7</ContactKey>
    <ContactMentionMarkup>sample string 7</ContactMentionMarkup>
    <DisplayName>sample string 4</DisplayName>
    <EmailAddress>sample string 5</EmailAddress>
    <IsMentionable>true</IsMentionable>
    <LinkToProfile>sample string 1</LinkToProfile>
    <PictureUrl>sample string 2</PictureUrl>
  </ContactMentionSearchResult>
</ArrayOfContactMentionSearchResult>