PageCommandsServices.Delete Method

PageCommandsServicesDelete Method

Ingeniux CMS Web Services API

Deletes a list of Pages

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<PageCommandReturnInformation> Delete(
	string[] pageIds,
	string pubTarget
)

Public Function Delete ( 
	pageIds As String(),
	pubTarget As String
) As XHRServiceResponseGeneric(Of PageCommandReturnInformation)

public:
virtual XHRServiceResponseGeneric<PageCommandReturnInformation^>^ Delete(
	array<String^>^ pageIds, 
	String^ pubTarget
) sealed

abstract Delete : 
        pageIds : string[] * 
        pubTarget : string -> XHRServiceResponseGeneric<PageCommandReturnInformation> 
override Delete : 
        pageIds : string[] * 
        pubTarget : string -> XHRServiceResponseGeneric<PageCommandReturnInformation>

Parameters

pageIds: Type: SystemString
Ids of the Pages to be deleted
pubTarget: Type: SystemString
Id of current Publishing Target

Return Value

Type: XHRServiceResponseGenericPageCommandReturnInformation

Information of the Page Command action and the properties of deleted Pages, without properties information

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "contentChanged": false,
        "pageAction": "delete",
        "pageProperties": null,
        "pages": [{
            "id": "x111",
            "props": null
        }, {
            "id": "x110",
            "props": null
        }],
        "queryString": null
    }
}

Remarks

If Page Ids are null or empty, or any of the Pages don't exist, return error status.

If current User doesn't have full control access of any of the Pages, return error status.

Reference

PageCommandsServices Class

IngeniuxCMService Namespace