<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}
"use strict";
/** @typedef {'Daily'|'Weekly'|'Manual'} */
export var SitemapGenerationCondition;
(function (SitemapGenerationCondition) {
    SitemapGenerationCondition["Daily"] = "Daily"
    SitemapGenerationCondition["Weekly"] = "Weekly"
    SitemapGenerationCondition["Manual"] = "Manual"
})(SitemapGenerationCondition || (SitemapGenerationCondition = {}));
export class SitemapSettings {
    /** @param {{IsEnabled?:boolean,UrlLimit?:number,Compress?:boolean,Condition?:SitemapGenerationCondition,DayToStart?:number,TimeToStart?:string,SiteId?:string,LastExecutionTime?:string,LastError?:string,PingGoogle?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    IsEnabled;
    /** @type {number} */
    UrlLimit;
    /** @type {boolean} */
    Compress;
    /** @type {SitemapGenerationCondition} */
    Condition;
    /** @type {number} */
    DayToStart;
    /** @type {string} */
    TimeToStart;
    /** @type {string} */
    SiteId;
    /** @type {string} */
    LastExecutionTime;
    /** @type {string} */
    LastError;
    /** @type {boolean} */
    PingGoogle;
}
export class SitemapSettingsMessage {
    /** @param {{Id?:string,Item?:SitemapSettings}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {SitemapSettings} */
    Item;
}
export class SitemapSettingsContext {
    /** @param {{Item?:SitemapSettings}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SitemapSettings} */
    Item;
}

JavaScript 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
	}
}