PageCommandsServices.Claim Method

PageCommandsServicesClaim Method

Ingeniux CMS Web Services API

Assigns a Page that is currently assigned to a User Group that current User belongs to.

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<PageCommandReturnInformation> Claim(
	string pageId,
	string pubTarget
)

Public Function Claim ( 
	pageId As String,
	pubTarget As String
) As XHRServiceResponseGeneric(Of PageCommandReturnInformation)

public:
virtual XHRServiceResponseGeneric<PageCommandReturnInformation^>^ Claim(
	String^ pageId, 
	String^ pubTarget
) sealed

abstract Claim : 
        pageId : string * 
        pubTarget : string -> XHRServiceResponseGeneric<PageCommandReturnInformation> 
override Claim : 
        pageId : string * 
        pubTarget : string -> XHRServiceResponseGeneric<PageCommandReturnInformation>

Parameters

pageId: Type: SystemString
Id of the Page to claim
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": "claim",
        "pageProperties": {
            "name": "CompTest2",
            "allowedCategoryRoots": [],
            "ancestors": ["x1", "x2"],
            "assignedGroup": null,
            "assignedUser": {
                "name": "Turtle Master",
                "email": "",
                "userId": "INGENIUX\\awang"
            },
            "canClaimPage": false,
            "canTranslate": false,
            "checkedOut": true,
            "error": null,
            "icon": 9,
            "isAssignedToOtherUser": false,
            "isEditable": true,
            "isInWorkflow": false,
            "justRecycled": false,
            "languageRootId": "",
            "lingualMaps": {
                "clones": [],
                "master": null
            },
            "locale": "",
            "localeInherited": true,
            "markedForPublish": false,
            "markedForPublishAny": false,
            "markedForPublishPropagated": false,
            "nextPageId": null,
            "nextPageIndex": 0,
            "noDnd": false,
            "numChildPages": 0,
            "pageId": "x111",
            "parentId": null,
            "pendingMasterVersion": 0,
            "referenceProps": {
                "created": "20140121T22:51:36",
                "createdBy": "INGENIUX\\awang",
                "endDate": "00010101T00:00:00",
                "lastModified": "20140125T01:09:34",
                "lastModifiedBy": "User\/INGENIUX___awang",
                "publishAs": "",
                "startDate": "00010101T00:00:00"
            },
            "remoteServer": "",
            "schemaFriendlyName": "CompTest",
            "schemaName": "CompTest",
            "schemaOnLatestVersion": true,
            "securityLevel": 2,
            "userCanCopyPage": true,
            "workflow": null
        },
        "pages": null,
        "queryString": {
            "assignTargetId": null,
            "assignToGroup": null,
            "comment": null,
            "includeChildren": false,
            "newPageName": null,
            "pageAction": null,
            "pageId": null,
            "pageIds": null,
            "transitionId": null
        }
    }
}

Remarks

If Page doesn't exist, returns error status.

If Page is not assigned to a User Group, or the current User is not a member of that User Group, returns error status.

Reference

PageCommandsServices Class

IngeniuxCMService Namespace