NGOPurgeLog

This call is used to purge or delete the Log generated for the objects. If the Log for some particular actions is to be purged, then the Action Indexes for those Logs are sent. Also, the particular Group or userUser or ActionLogIds and objects for which the Log is to be purged can be specified.

 

Input Parameter description

View sample InputXml

Output Parameter description

View sample OutputXml

Errors and Warnings

 

 

Input Parameters description

Name

Parent Tag

Description

Valid Values

Default

Values

Option

Root

Unique option for the call.

NGOPurgeLog

N/A

CabinetName

Root

Name of the Cabinet to which the User wants to connect.

 

N/A

UserDBId

Root

UserDatabase ID that is returned in the NGOConnect

Cabinet call.

 

N/A

ActionIds

Root

It contains a List of Ids corresponding to which the Log is to be fetched.

 

N/A

ActionId

ActionIds

It specifies the Action ID corresponding to which the Log is to be fetched.

 

N/A

ActionLogIds

Root

It contains a list of Ids corresponding to which the Log is to be purged

 

 

ActionLogId

ActionLogIds

It specifies the Id (which defines an action) corresponding to which the Log is to be purged

 

 

GroupUserIds

Root

It specifies a List of Groups or User indexes for which the Log is to be fetched.

 

 

GroupUserIndex

Group

UserIds

It specifies either the Group or User Index for which the Log is to be fetched.

 

It will purge the Log for all Users or Groups according to action specified.

GroupUserFlag

Root

It specifies whether the call for purge Log is for a Group or a User.

G – Group

U – User

It will purge the Log for all Users and Groups who has performed the action according to the action specified.

ObjectIds

Root

It specifies a List of those object Indexes for which the Log is to be purged.

 

 

ObjectIndex

ObjectIds

It specifies the Index of the object for which the Log is to be purged.

 

It will purge the Log on all the objects according to action specified.

ObjectType

Root

It specifies the type of the objects (whose Indexes are sent in the ObjectIndex tags.)

 

 

DateFrom

Root

Specifies the Date starting from which the Log is to be purged.

 

 

DateTo

Root

Specifies the Date up to which the Log is to be purged.

 

 

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

Unique option for the call.

Status

Root

Status of the call. If the Status is 0, then the call is successful.

 

Errors returned from call

Code

Message

Comments

-50074

Invalid parameters.

The value for some input parameter is not correct or is invalid. This exception occurs when the flag that indicates whether the Index sent is of a User or Group is passed as null.