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