<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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<SuggestionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Search.Impl.Services.DTO">
  <IndexName>String</IndexName>
  <Language>String</Language>
  <ResultsForAllSites>false</ResultsForAllSites>
  <ScoringInfo>String</ScoringInfo>
  <SiteId>String</SiteId>
  <SuggestionFields>String</SuggestionFields>
  <Text>String</Text>
</SuggestionsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SuggestionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Search.Impl.Services.DTO">
  <Suggestions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Suggestions>
</SuggestionsResponse>