<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 .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"}]}