<back to all web services

SuggestionsRequest

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

export class SuggestionsRequest
{
    public IndexName: string;
    public SuggestionFields: string;
    public Text: string;
    public Language: string;
    public SiteId: string;
    public ScoringInfo: string;
    public ResultsForAllSites?: boolean;

    public constructor(init?: Partial<SuggestionsRequest>) { (Object as any).assign(this, init); }
}

export class SuggestionsResponse
{
    public Suggestions: string[];

    public constructor(init?: Partial<SuggestionsResponse>) { (Object as any).assign(this, init); }
}

TypeScript SuggestionsRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length

{"Suggestions":["String"]}