MarkForPublishServices.GetPageMarks Method

MarkForPublishServicesGetPageMarks Method

Ingeniux CMS Web Services API

Retrieves the Mark-for-publish information on given page(s)

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<PagePublishMarkingList> GetPageMarks(
	GetPageMarksInput data
)

Public Function GetPageMarks ( 
	data As GetPageMarksInput
) As XHRServiceResponseGeneric(Of PagePublishMarkingList)

public:
virtual XHRServiceResponseGeneric<PagePublishMarkingList^>^ GetPageMarks(
	GetPageMarksInput^ data
) sealed

abstract GetPageMarks : 
        data : GetPageMarksInput -> XHRServiceResponseGeneric<PagePublishMarkingList> 
override GetPageMarks : 
        data : GetPageMarksInput -> XHRServiceResponseGeneric<PagePublishMarkingList>

Parameters

data

Type: GetPageMarksInput

The information on the page(s) to request mark-for-publish information for

Examples

Sample JSON request

JavaScript

Copy

{
    "pageIds": ["x11"],
    "recursive": false
}

Return Value

Type: XHRServiceResponseGenericPagePublishMarkingList

Collection of Publishing Targets information, also indication on each target on whether or not the given pages are marked for the target, and which version of this page was marked for the given target.

Also, the collection of information on all available previous versions of the pages and the mark-for-publish information on each version.

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "pubTargets": [{
            "allowCurrentUser": true,
            "markedVersion": 4,
            "pubTargetId": "PublishingTargets\/1",
            "pubTargetName": "Live",
            "structuredUrlEnabled": true
        }, {
            "allowCurrentUser": true,
            "markedVersion": -1,
            "pubTargetId": "PublishingTargets\/33",
            "pubTargetName": "Staging",
            "structuredUrlEnabled": true
        }, {
            "allowCurrentUser": true,
            "markedVersion": -1,
            "pubTargetId": "PublishingTargets\/34",
            "pubTargetName": "Staging 2",
            "structuredUrlEnabled": true
        }],
        "versions": [{
            "CurrentVersion": true,
            "Date": "20140120T14:20:58",
            "MasterVersion": -1,
            "Name": "About Us",
            "PubTargets": "{\"version\":4,\"targets\":[{\"id\":\"PublishingTargets\/1\",\"name\":\"Live\"}]}",
            "User": "Turtle Master [INGENIUX\\awang]",
            "Version": 4
        }, {
            "CurrentVersion": false,
            "Date": "20131211T22:06:39",
            "MasterVersion": -1,
            "Name": "About Us",
            "PubTargets": "{\"version\":3,\"targets\":[]}",
            "User": "Turtle Master [INGENIUX\\awang]",
            "Version": 3
        }, {
            "CurrentVersion": false,
            "Date": "20131211T18:57:18",
            "MasterVersion": -1,
            "Name": "About Us",
            "PubTargets": "{\"version\":2,\"targets\":[]}",
            "User": "Turtle Master [INGENIUX\\awang]",
            "Version": 2
        }, {
            "CurrentVersion": false,
            "Date": "20131211T18:19:42",
            "MasterVersion": -1,
            "Name": "About Us",
            "PubTargets": "{\"version\":1,\"targets\":[]}",
            "User": "Turtle Master [INGENIUX\\awang]",
            "Version": 1
        }]
    }
}

Remarks

For each item in "pubTargets" collection: the "markedVersion" property indicating which version was marked for that target. If value is -1, then it is not marked for that target.

If multiple page ids are provided, the return marking information will be the first page in the selection. However, because it is on multiple pages, the "versions" collection will only list current version.

Reference

MarkForPublishServices Class

IngeniuxCMService Namespace