<back to all web services

SettingsRequest

The following routes are available for this service:
All Verbs/RestApi/search/settings
GET/RestApi/search/settings

export class SettingsRequest
{
    public IndexId: string;
    public SuggestionFields: string;
    public SectionName: string;
    public Text: string;
    public Take: number;
    public Skip: number;

    public constructor(init?: Partial<SettingsRequest>) { (Object as any).assign(this, init); }
}

export class SettingsResponse
{
    public Results: SettingDto[];

    public constructor(init?: Partial<SettingsResponse>) { (Object as any).assign(this, init); }
}

export class SettingDto
{
    public Title: string;
    public SectionName: string;
    public FullSettingName: string;
    public Path: string[];
    public VisiblePath: string;
    public FullPath: string;

    public constructor(init?: Partial<SettingDto>) { (Object as any).assign(this, init); }
}

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