<back to all web services

SitemapSettingsMessage

The following routes are available for this service:
All Verbs/RestApi/sitefinity/sitemap/settings
All Verbs/RestApi/sitefinity/sitemap/settings/{Id}

export enum SitemapGenerationCondition
{
    Daily = 'Daily',
    Weekly = 'Weekly',
    Manual = 'Manual',
}

export class SitemapSettings
{
    public IsEnabled: boolean;
    public UrlLimit: number;
    public Compress: boolean;
    public Condition: SitemapGenerationCondition;
    public DayToStart: number;
    public TimeToStart: string;
    public SiteId: string;
    public LastExecutionTime: string;
    public LastError: string;
    public PingGoogle: boolean;

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

export class SitemapSettingsMessage
{
    public Id: string;
    public Item: SitemapSettings;

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

export class SitemapSettingsContext
{
    public Item: SitemapSettings;

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

TypeScript SitemapSettingsMessage DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /RestApi/sitefinity/sitemap/settings HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Item: 
	{
		IsEnabled: False,
		UrlLimit: 0,
		Compress: False,
		Condition: Daily,
		DayToStart: 0,
		TimeToStart: 0001-01-01,
		LastExecutionTime: String,
		LastError: String,
		PingGoogle: False
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Item: 
	{
		IsEnabled: False,
		UrlLimit: 0,
		Compress: False,
		Condition: Daily,
		DayToStart: 0,
		TimeToStart: 0001-01-01,
		LastExecutionTime: String,
		LastError: String,
		PingGoogle: False
	}
}