<back to all web services

MobileFormatPreviewDto

The following routes are available for this service:
GET/RestApi/Sitefinity/mobile-formats/preview
"use strict";
/** @typedef {number} */
export var ContentLifecycleStatus;
(function (ContentLifecycleStatus) {
    ContentLifecycleStatus[ContentLifecycleStatus["Master"] = 0] = "Master"
    ContentLifecycleStatus[ContentLifecycleStatus["Temp"] = 1] = "Temp"
    ContentLifecycleStatus[ContentLifecycleStatus["Live"] = 2] = "Live"
    ContentLifecycleStatus[ContentLifecycleStatus["Deleted"] = 4] = "Deleted"
    ContentLifecycleStatus[ContentLifecycleStatus["PartialTemp"] = 8] = "PartialTemp"
})(ContentLifecycleStatus || (ContentLifecycleStatus = {}));
export class MobileFormatPreviewDto {
    /** @param {{MobileFormatSettingName?:string,ContentTypeFullname?:string,ProviderName?:string,ItemUrlName?:string,Status?:ContentLifecycleStatus,SiteId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    MobileFormatSettingName;
    /** @type {string} */
    ContentTypeFullname;
    /** @type {string} */
    ProviderName;
    /** @type {string} */
    ItemUrlName;
    /** @type {?ContentLifecycleStatus} */
    Status;
    /** @type {string} */
    SiteId;
}
export class MobileFormatPreviewUrlDto {
    /** @param {{ItemTitle?:string,MobileFormatUrl?:string,MobileFormatPreviewUrl?:string,ErrorMessage?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ItemTitle;
    /** @type {string} */
    MobileFormatUrl;
    /** @type {string} */
    MobileFormatPreviewUrl;
    /** @type {string} */
    ErrorMessage;
}

JavaScript MobileFormatPreviewDto 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.

GET /RestApi/Sitefinity/mobile-formats/preview HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ItemTitle: String,
	MobileFormatUrl: String,
	MobileFormatPreviewUrl: String,
	ErrorMessage: String
}