MarkForPublishServicesMarkPages Method

Ingeniux CMS Web Services API

Marks/unmarks the given Pages for publish on provided Publishing Targets. All involved pages will be marked the same way.

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.70
Syntax

public XHRServiceResponseGeneric<PageCommandReturnInformation> MarkPages(
	MarkPageInput data,
	string pubTarget
)

Parameters

data
Type: MarkPageInput

The instructions on Page's publish marking

Examples

Sample JSON input
JavaScript
{
        "pageIds": ["x89"],
        "markForPublish": [{
            "pubTarget": {
                "id": "PublishingTargets/1",
                "name": "Live"
            },
            "version": "1",
            "marked": true,
            "isCurrent": false
        }, {
            "pubTarget": {
                "id": "PublishingTargets/33",
                "name": "Staging"
            },
            "version": "1",
            "marked": true,
            "isCurrent": false
        }],
        "unmarkForPublish": [],
        "recursive": false
    }
pubTarget
Type: SystemString
The id of current Publishing Target. It is used to construct Page properties information on the result object.

Return Value

Type: XHRServiceResponseGenericPageCommandReturnInformation

The information of affected Page(s) after mark for publishing is done.

Examples

Sample JSON return
JavaScript
 {
    "code": 0,
    "error": null,
    "message": {
        "contentChanged": false,
        "pageAction": "markforpublish",
        "pageProperties": {
            "name": "DynamicExecutes",
            "allowedCategoryRoots": [],
            "ancestors": ["x1", "x2"],
            "assignedGroup": null,
            "assignedUser": {
                "name": "Turtle Master",
                "email": "",
                "userId": "INGENIUX\\awang"
            },
            "canClaimPage": false,
            "canTranslate": false,
            "checkedOut": true,
            "error": null,
            "icon": 1,
            "isAssignedToOtherUser": false,
            "isEditable": true,
            "isInWorkflow": false,
            "justRecycled": false,
            "languageRootId": "",
            "lingualMaps": {
                "clones": [],
                "master": null
            },
            "locale": "",
            "localeInherited": true,
            "markedForPublish": true,
            "markedForPublishAny": false,
            "markedForPublishPropagated": false,
            "nextPageId": null,
            "nextPageIndex": 0,
            "noDnd": false,
            "numChildPages": 6,
            "pageId": "x89",
            "parentId": null,
            "pendingMasterVersion": 0,
            "referenceProps": {
                "created": "20140107T21:57:04",
                "createdBy": "INGENIUX\\awang",
                "endDate": "00010101T00:00:00",
                "lastModified": "20140122T19:31:54",
                "lastModifiedBy": "User\/INGENIUX___awang",
                "publishAs": "",
                "startDate": "00010101T00:00:00"
            },
            "remoteServer": "",
            "schemaFriendlyName": "Folder",
            "schemaName": "Folder",
            "schemaOnLatestVersion": true,
            "securityLevel": 2,
            "userCanCopyPage": true,
            "workflow": null
        },
        "pages": [{
            "id": "x89",
            "props": {
                "name": "DynamicExecutes",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2"],
                "assignedGroup": null,
                "assignedUser": {
                    "name": "Turtle Master",
                    "email": "",
                    "userId": "INGENIUX\\awang"
                },
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": true,
                "error": null,
                "icon": 1,
                "isAssignedToOtherUser": false,
                "isEditable": true,
                "isInWorkflow": false,
                "justRecycled": false,
                "languageRootId": "",
                "lingualMaps": {
                    "clones": [],
                    "master": null
                },
                "locale": "",
                "localeInherited": true,
                "markedForPublish": true,
                "markedForPublishAny": false,
                "markedForPublishPropagated": false,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 6,
                "pageId": "x89",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20140107T21:57:04",
                    "createdBy": "INGENIUX\\awang",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140122T19:31:54",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "Folder",
                "schemaOnLatestVersion": false,
                "securityLevel": 2,
                "userCanCopyPage": true,
                "workflow": null
            }
        }],
        "queryString": {
            "assignTargetId": null,
            "assignToGroup": null,
            "comment": null,
            "includeChildren": false,
            "newPageName": null,
            "pageAction": null,
            "pageId": null,
            "pageIds": null,
            "transitionId": null
        },
        "returnMessage": null
    }
}
Remarks

If we are marking on multiple pages, we can only mark/unmark each page on its current version. Otherwise, we can mark page on any of its available previous versions.

See Also

Reference