<back to all web services

SettingsRequest

The following routes are available for this service:
All Verbs/RestApi/search/settings
GET/RestApi/search/settings
SettingsRequest Parameters:
NameParameterData TypeRequiredDescription
IndexIdqueryGuidNo
SuggestionFieldsquerystringNo
SectionNamequerystringNo
TextquerystringNo
TakequeryintNo
SkipqueryintNo
SettingsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformSettingDto[]No
SettingDto Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
SectionNameformstringNo
FullSettingNameformstringNo
PathformICollection<string>No
VisiblePathformstringNo
FullPathformstringNo

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

HTTP + OTHER

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

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

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