<back to all web services

SuggestionsRequest

The following routes are available for this service:
All Verbs/RestApi/search/suggestions
GET/RestApi/search/suggestions
"use strict";
export class SuggestionsRequest {
    /** @param {{IndexName?:string,SuggestionFields?:string,Text?:string,Language?:string,SiteId?:string,ScoringInfo?:string,ResultsForAllSites?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    IndexName;
    /** @type {string} */
    SuggestionFields;
    /** @type {string} */
    Text;
    /** @type {string} */
    Language;
    /** @type {string} */
    SiteId;
    /** @type {string} */
    ScoringInfo;
    /** @type {?boolean} */
    ResultsForAllSites;
}
export class SuggestionsResponse {
    /** @param {{Suggestions?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string[]} */
    Suggestions;
}

JavaScript SuggestionsRequest DTOs

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

HTTP + CSV

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

{"Suggestions":["String"]}