<back to all web services

SettingsRequest

The following routes are available for this service:
All Verbs/RestApi/search/settings
GET/RestApi/search/settings
namespace Telerik.Sitefinity.Search.Impl.Services.DTO

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SettingsRequest() = 
        member val IndexId:Guid = new Guid() with get,set
        member val SuggestionFields:String = null with get,set
        member val SectionName:String = null with get,set
        member val Text:String = null with get,set
        member val Take:Int32 = new Int32() with get,set
        member val Skip:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type SettingsResponse() = 
        member val Results:SettingDto[] = [||] with get,set

    [<AllowNullLiteral>]
    type SettingDto() = 
        member val Title:String = null with get,set
        member val SectionName:String = null with get,set
        member val FullSettingName:String = null with get,set
        member val Path:ICollection<String> = null with get,set
        member val VisiblePath:String = null with get,set
        member val FullPath:String = null with get,set

F# 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>