MarkForPublishServices.CheckPagesMarkedForTarget Method

MarkForPublishServicesCheckPagesMarkedForTarget Method

Ingeniux CMS Web Services API

Similar to the operation "GetPageMarks". However, this operation is geared towards returning mark for publishing information on a perticular Publishing Target. Also, it's return information is a lot simpler.

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<PageMarkForPublishSimpleInfo[]> CheckPagesMarkedForTarget(
	GetPageMarksInput data,
	string pubTarget
)

Public Function CheckPagesMarkedForTarget ( 
	data As GetPageMarksInput,
	pubTarget As String
) As XHRServiceResponseGeneric(Of PageMarkForPublishSimpleInfo())

public:
virtual XHRServiceResponseGeneric<array<PageMarkForPublishSimpleInfo^>^>^ CheckPagesMarkedForTarget(
	GetPageMarksInput^ data, 
	String^ pubTarget
) sealed

abstract CheckPagesMarkedForTarget : 
        data : GetPageMarksInput * 
        pubTarget : string -> XHRServiceResponseGeneric<PageMarkForPublishSimpleInfo[]> 
override CheckPagesMarkedForTarget : 
        data : GetPageMarksInput * 
        pubTarget : string -> XHRServiceResponseGeneric<PageMarkForPublishSimpleInfo[]>

Parameters

data

Type: GetPageMarksInput

The information on what pages to check whether or not they are marked for given Publishing Target

Examples

Sample JSON input

JavaScript

Copy

{
    "pubTargetName": "Live",
    "pageIds": ["x1", "x2", "RecycleBin", "x112", "x111", "x110", "x100", "x99", "x89", "x5", "x3", "x11", "x12", "x15", "x9"]
}

pubTarget

Type: SystemString
The Id of the Publishing Target

Return Value

Type: XHRServiceResponseGenericPageMarkForPublishSimpleInfo

Collection of page marking information

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": [{
        "markedForPublish": false,
        "pageId": "x1"
    }, {
        "markedForPublish": false,
        "pageId": "RecycleBin"
    }, {
        "markedForPublish": true,
        "pageId": "x2"
    }, {
        "markedForPublish": false,
        "pageId": "x112"
    }, {
        "markedForPublish": false,
        "pageId": "x111"
    }, {
        "markedForPublish": false,
        "pageId": "x110"
    }, {
        "markedForPublish": false,
        "pageId": "x100"
    }, {
        "markedForPublish": false,
        "pageId": "x99"
    }, {
        "markedForPublish": true,
        "pageId": "x89"
    }, {
        "markedForPublish": true,
        "pageId": "x5"
    }, {
        "markedForPublish": true,
        "pageId": "x3"
    }, {
        "markedForPublish": true,
        "pageId": "x11"
    }, {
        "markedForPublish": true,
        "pageId": "x12"
    }, {
        "markedForPublish": false,
        "pageId": "x15"
    }, {
        "markedForPublish": true,
        "pageId": "x9"
    }]
}

Remarks

This operation is used on Ingeniux CMS client to found if Pages show on Site Tree are marked for given Publishing Target or not

Reference

MarkForPublishServices Class

IngeniuxCMService Namespace