GET restapi/personal/instantmessages/suggestions/v1?searchText={searchText}&maxSuggestions={maxSuggestions}

Searches for suggestions of person names or thread names that match the input search query for the current user

Request Information

URI Parameters

Name	Description	Type	Additional information
searchText	The query to get suggestions for	string	Required
maxSuggestions	The maximum number of suggestions to return (defaults to 10 if not supplied)	integer	None.

Body Parameters

None.

Response Information

Resource Description

Array of suggestions that match the specified query

Collection of Itslearning.RestApi.Entities.InstantMessageFilterSuggestion

Name	Description	Type	Additional information
Type	Type can be: OneToOne, Course, Project, Group	string	None.
Id	PersonId if TypeName == OneToOne, or ThreadId if otherwise	integer	None.
Label	Label for the suggestion	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Type": "sample string 1",
    "Id": 2,
    "Label": "sample string 3"
  },
  {
    "Type": "sample string 1",
    "Id": 2,
    "Label": "sample string 3"
  }
]

application/xml, text/xml

Sample:

<ArrayOfInstantMessageFilterSuggestion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities">
  <InstantMessageFilterSuggestion>
    <Id>2</Id>
    <Label>sample string 3</Label>
    <Type>sample string 1</Type>
  </InstantMessageFilterSuggestion>
  <InstantMessageFilterSuggestion>
    <Id>2</Id>
    <Label>sample string 3</Label>
    <Type>sample string 1</Type>
  </InstantMessageFilterSuggestion>
</ArrayOfInstantMessageFilterSuggestion>