NGOFetchLog

This call is used to fetch the Log generated for the objects. If the Log is required for some particular actions alone, then the List of Action Ids for those particular actions alone should be sent else nothing is to be sent when the Log for all the actions performed on the objects is required. UserUser can also specify the Groups or userUsers who have performed the action and objects for which the Log is to be fetched. UserUser can fetch Log either for Groups or userUsers at a time.

 

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.

NGOFetchLog

 

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

ActionLogIds

Root

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

 

N/A

ActionLogId

ActionLog

Ids

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

 

For All defined Action Log will be generated.

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.

 

Log will be For all Groups and Users who have performed the action.

GroupUserFlag

Root

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

G – Group

U – User

By default, for all Users and Groups Log will be generated.

ObjectIds

Root

It specifies a List of those Object Indexes for which the Log is to be fetched.

 

N/A

ObjectIndex

ObjectIds

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

 

For all objects Log will be generated.

ObjectType

Root

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

 

For all objects Log will be generated.

FolderIndex

Root

Specifies the Index of the folder in which the objects whose Log is to be fetched lies directly or in its subfolders.

 

 

IncludeSub

Folders

Root

Specifies whether the subfolders are to be included or not when the Log is to be fetched.

 

Y

DateFrom

Root

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

 

 

DateTo

Root

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

 

 

TotalCountFlag

Root

Specifies whether total count of Records obtained from the Fetch Log call is required or not.

Y – Total count is required.

N – Total count is not required.

N

PreviousAction

Index

Root

This tag is used for fetching Log of actions in batches. It specifies the Index of the last action in the previous batch. For the first batch, value of the field is 0.

 

 

PreviousAction

Root

This tag is used for fetching Log of actions in batches. It specifies the value of the last action performed in the previous batch on which sorting is done.

 

 

NoOfRecordsTo

Fetch

Root

It specifies the total number of Records for the Log that is to be fetched.

 

Batch size configured at Server.

 

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.

NoOfRecordsFetched

Root

It specifies the total number of Records fetched from the call for Fetch Log.

TotalNoOfRecords

Root

It specifies the count for total Records for Log, if TotalCountFlag is ‘Y’ otherwise it will exceed by one from NoOfRecordsFetched.

AuditTrails

Root

It contains the List of all the Logs fetched.

AuditLog

AuditTrailsRoot

It specifies the details about a particular Log.

ActionId

AuditLog

It specifies the Index of the action performed.

ActionLogId

AuditLog

It specifies the Id (which defines an action) corresponding to which the Log was fetched.

ObjectIndex

AuditLog

It specifies the Index of the object for which the Log was fetched.

ObjectName

AuditLog

It specifies the name of the object for which the Log was fetched.

ObjectType

AuditLog

It specifies the type of the object for which the Log was fetched.

UserIndex

AuditLog

It specifies the Index of the User who has performed the action for which the Log was fetched.

UserName

AuditLog

It specifies the name of the User who has performed the action for which the Log was fetched.

ActionDateTime

AuditLog

It specifies the Date and Time when the action was performed.

NewValue

AuditLog

It specifies the new changed value of the object on which the action was performed for which the Log was fetched.

OldValue

AuditLog

It specifies the old value of the object before the action was performed on it for which the Log was fetched.

 

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.