<back to all web services

SuggestionsRequest

The following routes are available for this service:
All Verbs/RestApi/search/suggestions
GET/RestApi/search/suggestions
SuggestionsRequest Parameters:
NameParameterData TypeRequiredDescription
IndexNamequerystringNo
SuggestionFieldsquerystringNo
TextquerystringNo
LanguagequerystringNo
SiteIdquerystringNo
ScoringInfoquerystringNo
ResultsForAllSitesquerybool?No
SuggestionsResponse Parameters:
NameParameterData TypeRequiredDescription
Suggestionsformstring[]No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /RestApi/search/suggestions HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	IndexName: String,
	SuggestionFields: String,
	Text: String,
	Language: String,
	SiteId: String,
	ScoringInfo: String,
	ResultsForAllSites: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Suggestions: 
	[
		String
	]
}