<back to all web services

SettingsRequest

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

public class SettingsRequest : Codable
{
    public var indexId:String
    public var suggestionFields:String
    public var sectionName:String
    public var text:String
    public var take:Int
    public var skip:Int

    required public init(){}
}

public class SettingsResponse : Codable
{
    public var results:[SettingDto] = []

    required public init(){}
}

public class SettingDto : Codable
{
    public var title:String
    public var sectionName:String
    public var fullSettingName:String
    public var path:[String] = []
    public var visiblePath:String
    public var fullPath:String

    required public init(){}
}


Swift SettingsRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

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

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