<back to all web services

SuggestionsRequest

The following routes are available for this service:
All Verbs/RestApi/search/suggestions
GET/RestApi/search/suggestions
import 'package:servicestack/servicestack.dart';

class SuggestionsRequest implements IConvertible
{
    String? IndexName;
    String? SuggestionFields;
    String? Text;
    String? Language;
    String? SiteId;
    String? ScoringInfo;
    bool? ResultsForAllSites;

    SuggestionsRequest({this.IndexName,this.SuggestionFields,this.Text,this.Language,this.SiteId,this.ScoringInfo,this.ResultsForAllSites});
    SuggestionsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        IndexName = json['IndexName'];
        SuggestionFields = json['SuggestionFields'];
        Text = json['Text'];
        Language = json['Language'];
        SiteId = json['SiteId'];
        ScoringInfo = json['ScoringInfo'];
        ResultsForAllSites = json['ResultsForAllSites'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'IndexName': IndexName,
        'SuggestionFields': SuggestionFields,
        'Text': Text,
        'Language': Language,
        'SiteId': SiteId,
        'ScoringInfo': ScoringInfo,
        'ResultsForAllSites': ResultsForAllSites
    };

    getTypeName() => "SuggestionsRequest";
    TypeContext? context = _ctx;
}

class SuggestionsResponse implements IConvertible
{
    List<String>? Suggestions;

    SuggestionsResponse({this.Suggestions});
    SuggestionsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Suggestions = JsonConverters.fromJson(json['Suggestions'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Suggestions': JsonConverters.toJson(Suggestions,'List<String>',context!)
    };

    getTypeName() => "SuggestionsResponse";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'www.asg.com.au', types: <String, TypeInfo> {
    'SuggestionsRequest': TypeInfo(TypeOf.Class, create:() => SuggestionsRequest()),
    'SuggestionsResponse': TypeInfo(TypeOf.Class, create:() => SuggestionsResponse()),
});

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