<back to all web services

SettingsRequest

The following routes are available for this service:
All Verbs/RestApi/search/settings
GET/RestApi/search/settings
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SettingsRequest
    {
        public UUID IndexId = null;
        public String SuggestionFields = null;
        public String SectionName = null;
        public String Text = null;
        public Integer Take = null;
        public Integer Skip = null;
        
        public UUID getIndexId() { return IndexId; }
        public SettingsRequest setIndexId(UUID value) { this.IndexId = value; return this; }
        public String getSuggestionFields() { return SuggestionFields; }
        public SettingsRequest setSuggestionFields(String value) { this.SuggestionFields = value; return this; }
        public String getSectionName() { return SectionName; }
        public SettingsRequest setSectionName(String value) { this.SectionName = value; return this; }
        public String getText() { return Text; }
        public SettingsRequest setText(String value) { this.Text = value; return this; }
        public Integer getTake() { return Take; }
        public SettingsRequest setTake(Integer value) { this.Take = value; return this; }
        public Integer getSkip() { return Skip; }
        public SettingsRequest setSkip(Integer value) { this.Skip = value; return this; }
    }

    public static class SettingsResponse
    {
        public ArrayList<SettingDto> Results = null;
        
        public ArrayList<SettingDto> getResults() { return Results; }
        public SettingsResponse setResults(ArrayList<SettingDto> value) { this.Results = value; return this; }
    }

    public static class SettingDto
    {
        public String Title = null;
        public String SectionName = null;
        public String FullSettingName = null;
        public ArrayList<String> Path = null;
        public String VisiblePath = null;
        public String FullPath = null;
        
        public String getTitle() { return Title; }
        public SettingDto setTitle(String value) { this.Title = value; return this; }
        public String getSectionName() { return SectionName; }
        public SettingDto setSectionName(String value) { this.SectionName = value; return this; }
        public String getFullSettingName() { return FullSettingName; }
        public SettingDto setFullSettingName(String value) { this.FullSettingName = value; return this; }
        public ArrayList<String> getPath() { return Path; }
        public SettingDto setPath(ArrayList<String> value) { this.Path = value; return this; }
        public String getVisiblePath() { return VisiblePath; }
        public SettingDto setVisiblePath(String value) { this.VisiblePath = value; return this; }
        public String getFullPath() { return FullPath; }
        public SettingDto setFullPath(String value) { this.FullPath = value; return this; }
    }

}

Java SettingsRequest 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/settings HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	SuggestionFields: String,
	SectionName: String,
	Text: String,
	Take: 0,
	Skip: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Results: 
	[
		{
			Title: String,
			SectionName: String,
			FullSettingName: String,
			VisiblePath: String,
			FullPath: String
		}
	]
}