PageCommandsServicesAssign Method Ingeniux CMS Web Services API

Assigned a list of Pages to specified User or Group

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

public XHRServiceResponseGeneric<PageCommandReturnInformation> Assign(
	string[] pageIds,
	string assignTargetId,
	bool assignToGroup,
	string comment,
	string pubTarget = ""
)

Parameters

pageIds
Type: SystemString
Ids of Pages to be assigned
assignTargetId
Type: SystemString
Id of User or User Group to assign the Pages to
assignToGroup
Type: SystemBoolean
Whether the specified Id is of User or User Group
comment
Type: SystemString
Comment for Assignment
pubTarget (Optional)
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
{
    "code": 0,
    "error": null,
    "message": {
        "contentChanged": false,
        "pageAction": "addtoworkflow",
        "pageProperties": {
            "name": "Home",
            "allowedCategoryRoots": [],
            "ancestors": ["x1", "x2"],
            "assignedGroup": {
                "name": "Authors",
                "canClaimPage": false,
                "groupId": "UserGroup\/2"
            },
            "assignedUser": null,
            "canClaimPage": false,
            "canTranslate": false,
            "checkedOut": false,
            "error": null,
            "icon": 7,
            "isAssignedToOtherUser": true,
            "isEditable": false,
            "isInWorkflow": true,
            "justRecycled": false,
            "languageRootId": "",
            "lingualMaps": {
                "clones": [],
                "master": null
            },
            "locale": "",
            "localeInherited": true,
            "markedForPublish": true,
            "markedForPublishAny": true,
            "markedForPublishPropagated": true,
            "nextPageId": null,
            "nextPageIndex": 0,
            "noDnd": false,
            "numChildPages": 9,
            "pageId": "x11",
            "parentId": null,
            "pendingMasterVersion": 0,
            "referenceProps": {
                "created": "20081117T07:28:18",
                "createdBy": "ingeniux\\ashley",
                "endDate": "99991231T23:59:59",
                "lastModified": "20140124T23:15:18",
                "lastModifiedBy": "User\/ingeniux___awang",
                "publishAs": "",
                "startDate": "00010101T00:00:00"
            },
            "remoteServer": "",
            "schemaFriendlyName": null,
            "schemaName": "Home",
            "schemaOnLatestVersion": false,
            "securityLevel": 2,
            "userCanCopyPage": true,
            "workflow": null
        },
        "pages": [{
            "id": "x11",
            "props": {
                "name": "Home",
                "allowedCategoryRoots": [],
                "ancestors": ["x1", "x2"],
                "assignedGroup": {
                    "name": "Authors",
                    "canClaimPage": false,
                    "groupId": "UserGroup\/2"
                },
                "assignedUser": null,
                "canClaimPage": false,
                "canTranslate": false,
                "checkedOut": false,
                "error": null,
                "icon": 7,
                "isAssignedToOtherUser": true,
                "isEditable": false,
                "isInWorkflow": true,
                "justRecycled": false,
                "languageRootId": "",
                "lingualMaps": {
                    "clones": [],
                    "master": null
                },
                "locale": "",
                "localeInherited": true,
                "markedForPublish": true,
                "markedForPublishAny": true,
                "markedForPublishPropagated": true,
                "nextPageId": null,
                "nextPageIndex": 0,
                "noDnd": false,
                "numChildPages": 9,
                "pageId": "x11",
                "parentId": null,
                "pendingMasterVersion": 0,
                "referenceProps": {
                    "created": "20081117T07:28:18",
                    "createdBy": "ingeniux\\ashley",
                    "endDate": "99991231T23:59:59",
                    "lastModified": "20140124T23:15:18",
                    "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
        }
    }
}
Remarks

If any Pages don't exist, returns error

If assign target id is not specified, Pages will be unassigned. However, it it is specified, but the User or User Group doesn't exist, returns error.

See Also

Reference