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

<SettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Search.Impl.Services.DTO">
  <IndexId>00000000-0000-0000-0000-000000000000</IndexId>
  <SectionName>String</SectionName>
  <Skip>0</Skip>
  <SuggestionFields>String</SuggestionFields>
  <Take>0</Take>
  <Text>String</Text>
</SettingsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Search.Impl.Services.DTO">
  <Results>
    <SettingDto>
      <FullPath>String</FullPath>
      <FullSettingName>String</FullSettingName>
      <Path xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <SectionName>String</SectionName>
      <Title>String</Title>
      <VisiblePath>String</VisiblePath>
    </SettingDto>
  </Results>
</SettingsResponse>