<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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<SitemapSettingsMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.SitemapGenerator.Data">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Item>
    <Compress>false</Compress>
    <Condition>Daily</Condition>
    <DayToStart>0</DayToStart>
    <IsEnabled>false</IsEnabled>
    <LastError>String</LastError>
    <LastExecutionTime>String</LastExecutionTime>
    <PingGoogle>false</PingGoogle>
    <SiteId>00000000-0000-0000-0000-000000000000</SiteId>
    <TimeToStart>0001-01-01T00:00:00</TimeToStart>
    <UrlLimit>0</UrlLimit>
  </Item>
</SitemapSettingsMessage>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SitemapSettingsContext xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.SitemapGenerator.Data">
  <Item>
    <Compress>false</Compress>
    <Condition>Daily</Condition>
    <DayToStart>0</DayToStart>
    <IsEnabled>false</IsEnabled>
    <LastError>String</LastError>
    <LastExecutionTime>String</LastExecutionTime>
    <PingGoogle>false</PingGoogle>
    <SiteId>00000000-0000-0000-0000-000000000000</SiteId>
    <TimeToStart>0001-01-01T00:00:00</TimeToStart>
    <UrlLimit>0</UrlLimit>
  </Item>
</SitemapSettingsContext>