PageCommandsServicesCheckOut Method |
Checks out a list of Pages to current user
Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.169
Syntaxpublic XHRServiceResponseGeneric<PageCommandReturnInformation> CheckOut( string[] pageIds, bool includeChildren, string pubTarget = "" )
Parameters
- pageIds
- Type: SystemString
Ids of the Pages to check out - includeChildren
- Type: SystemBoolean
Whether or not to also check out the descendants of the Pages - pubTarget (Optional)
- Type: SystemString
Id of current Publishing Target
Return Value
Type: XHRServiceResponseGenericPageCommandReturnInformationInformation of the Page Command action and the properties of updated Pages
Examples
Sample JSON return
JavaScript
{
"code": 0,
"error": null,
"message": {
"contentChanged": false,
"pageAction": "checkout",
"pageProperties": {
"name": "Home",
"allowedCategoryRoots": [],
"ancestors": ["x1", "x2"],
"assignedGroup": null,
"assignedUser": {
"name": "Turtle Master",
"email": "",
"userId": "INGENIUX\\awang"
},
"canClaimPage": false,
"canTranslate": false,
"checkedOut": true,
"error": null,
"icon": 8,
"isAssignedToOtherUser": false,
"isEditable": true,
"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": "20140125T01:04:19",
"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": {
"name": "Turtle Master",
"email": "",
"userId": "INGENIUX\\awang"
},
"canClaimPage": false,
"canTranslate": false,
"checkedOut": true,
"error": null,
"icon": 8,
"isAssignedToOtherUser": false,
"isEditable": true,
"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": "20140125T01:04:19",
"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