<back to all web services

SuggestionsRequest

The following routes are available for this service:
All Verbs/RestApi/search/suggestions
GET/RestApi/search/suggestions
import Foundation
import ServiceStack

public class SuggestionsRequest : Codable
{
    public var indexName:String
    public var suggestionFields:String
    public var text:String
    public var language:String
    public var siteId:String
    public var scoringInfo:String
    public var resultsForAllSites:Bool?

    required public init(){}
}

public class SuggestionsResponse : Codable
{
    public var suggestions:[String] = []

    required public init(){}
}


Swift SuggestionsRequest DTOs

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
	]
}