<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.*


open class SettingsRequest
{
    var IndexId:UUID? = null
    var SuggestionFields:String? = null
    var SectionName:String? = null
    var Text:String? = null
    var Take:Int? = null
    var Skip:Int? = null
}

open class SettingsResponse
{
    var Results:ArrayList<SettingDto>? = null
}

open class SettingDto
{
    var Title:String? = null
    var SectionName:String? = null
    var FullSettingName:String? = null
    var Path:ArrayList<String> = ArrayList<String>()
    var VisiblePath:String? = null
    var FullPath:String? = null
}

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