PageCommandsServicesCheckIn Method Ingeniux CMS Web Services API
Checks in specified Pages, which publish-marking information

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)
Syntax
Copy
public XHRServiceResponseGeneric<PageCommandReturnInformation> CheckIn(
	string[] pageIds,
	bool includeChildren,
	PublishMarking publishMarking,
	string pubTarget
)

Parameters

pageIds
Type: SystemString
Ids of Pages to be checked in.
includeChildren
Type: SystemBoolean
Whether or not to check in the descendants of specified Pages
publishMarking
Type: PublishMarking

Publish Marking information. We can specified which Publishing Target will be marked for the Page's latest version after check in. Marked Targets not listed will use the previous version.

Examples
Sample JSON return
JavaScript
Copy
{
    "profileSelected": true,
    "profile": {
        "id": "custom",
        "name": ""
    },
    "pubTargets": [{
        "id": "PublishingTargets/1",
        "name": "Live"
    }]
}
pubTarget
Type: SystemString
Id of current Publishing Target

Return Value

Type: XHRServiceResponseGenericPageCommandReturnInformation

Information of the Page Command action and the properties of updated Pages

Examples
Sample JSON return
JavaScript
Copy
{
    "code": 0,
    "error": null,
    "message": {
        "contentChanged": false,
        "pageAction": "checkin",
        "pageProperties": {
            "name": "Home",
            "allowedCategoryRoots": [],
            "ancestors": ["x1", "x2"],
            "assignedGroup": null,
            "assignedUser": null,
            "canClaimPage": false,
            "canTranslate": false,
            "checkedOut": false,
            "error": null,
            "icon": 8,
            "isAssignedToOtherUser": false,
            "isEditable": false,
            "isInWorkflow": false,
            "justRecycled": false,
            "languageRootId": "",
            "lingualMaps": {
                "clones": [],
                "master": null
            },
            "locale": "",
            "localeInherited": true,
            "markedForPublish": true,
            "markedForPublishAny": true,
            "markedForPublishPropagated": true,
            "nextPageId": null,
            "nextPageIndex": 0,
            "noDnd": false,
            "numChildPages": 4,
            "pageId": "x5",
            "parentId": null,
            "pendingMasterVersion": 0,
            "referenceProps": {
                "created": "20131207T00:07:46",
                "createdBy": "INGENIUX\\awang",
                "endDate": "00010101T00:00:00",
                "lastModified": "20140125T00:44:51",
                "lastModifiedBy": "User\/INGENIUX___awang",
                "publishAs": "",
                "startDate": "00010101T00:00:00"
            },
            "remoteServer": "",
            "schemaFriendlyName": null,
            "schemaName": "Home",
            "schemaOnLatestVersion": false,
            "securityLevel": 2,
            "userCanCopyPage": true,
            "workflow": null
        },
        "pages": [{
            "id": "x5",
            "props": {
                "name": "Home",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2"],
                "assignedGroup": null,
                "assignedUser": null,
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": false,
                "error": null,
                "icon": 8,
                "isAssignedToOtherUser": false,
                "isEditable": false,
                "isInWorkflow": false,
                "justRecycled": false,
                "languageRootId": "",
                "lingualMaps": {
                    "clones": [],
                    "master": null
                },
                "locale": "",
                "localeInherited": true,
                "markedForPublish": true,
                "markedForPublishAny": true,
                "markedForPublishPropagated": true,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 4,
                "pageId": "x5",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20131207T00:07:46",
                    "createdBy": "INGENIUX\\awang",
                    "endDate": "00010101T00:00:00",
                    "lastModified": "20140125T00:44:51",
                    "lastModifiedBy": "User\/INGENIUX___awang",
                    "publishAs": "",
                    "startDate": "00010101T00:00:00"
                },
                "remoteServer": "",
                "schemaFriendlyName": null,
                "schemaName": "Home",
                "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
        }
    }
}
See Also

Reference

PageCommandsServices Class
IngeniuxCMService Namespace