<back to all web services

SuggestionsRequest

The following routes are available for this service:
All Verbs/RestApi/search/suggestions
GET/RestApi/search/suggestions
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SuggestionsRequest:
    index_name: Optional[str] = None
    suggestion_fields: Optional[str] = None
    text: Optional[str] = None
    language: Optional[str] = None
    site_id: Optional[str] = None
    scoring_info: Optional[str] = None
    results_for_all_sites: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SuggestionsResponse:
    suggestions: Optional[List[str]] = None

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