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