<back to all web services

SettingsRequest

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

Namespace Global

    Namespace Telerik.Sitefinity.Search.Impl.Services.DTO

        Public Partial Class SettingDto
            Public Overridable Property Title As String
            Public Overridable Property SectionName As String
            Public Overridable Property FullSettingName As String
            Public Overridable Property Path As ICollection(Of String)
            Public Overridable Property VisiblePath As String
            Public Overridable Property FullPath As String
        End Class

        Public Partial Class SettingsRequest
            Public Overridable Property IndexId As Guid
            Public Overridable Property SuggestionFields As String
            Public Overridable Property SectionName As String
            Public Overridable Property Text As String
            Public Overridable Property Take As Integer
            Public Overridable Property Skip As Integer
        End Class

        Public Partial Class SettingsResponse
            Public Sub New()
                Results = New SettingDto(){}
            End Sub

            Public Overridable Property Results As SettingDto()
        End Class
    End Namespace
End Namespace

VB.NET SettingsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"SuggestionFields":"String","SectionName":"String","Text":"String","Take":0,"Skip":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"Title":"String","SectionName":"String","FullSettingName":"String","VisiblePath":"String","FullPath":"String"}]}