<back to all web services

SettingsRequest

The following routes are available for this service:
All Verbs/RestApi/search/settings
GET/RestApi/search/settings
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Telerik.Sitefinity.Search.Impl.Services.DTO;

namespace Telerik.Sitefinity.Search.Impl.Services.DTO
{
    public partial class SettingDto
    {
        public virtual string Title { get; set; }
        public virtual string SectionName { get; set; }
        public virtual string FullSettingName { get; set; }
        public virtual ICollection<string> Path { get; set; }
        public virtual string VisiblePath { get; set; }
        public virtual string FullPath { get; set; }
    }

    public partial class SettingsRequest
    {
        public virtual Guid IndexId { get; set; }
        public virtual string SuggestionFields { get; set; }
        public virtual string SectionName { get; set; }
        public virtual string Text { get; set; }
        public virtual int Take { get; set; }
        public virtual int Skip { get; set; }
    }

    public partial class SettingsResponse
    {
        public SettingsResponse()
        {
            Results = new SettingDto[]{};
        }

        public virtual SettingDto[] Results { get; set; }
    }

}

C# 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
		}
	]
}