NGOFetchAuditTrail

This call retrieves the audit trail information for a given action and it is an Application specific call. All the records satisfying the Fetch criteria are retrieved. All the log actions are encapsulated into major Categories.

 

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

NGOFetch

AuditTrail

N/A

CabinetName

Root

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

 

N/A

UserDBId

Root

UserDatabase ID, which is returned in the NGOConnectCabinet call.

 

N/A

Category

Root

Different log actions can be categorized into categories such as Cabinet, Folder, Document etc.

 

N/A

ObjectIndex

Root

Index of the object whose audit trail is to be fetched.

Integer > 0

N/A

ObjectType

Root

Type of the object e.g. F - Folder,

D - Document,

A – Actionitem etc.

 

N/A

DateFrom

Root

Date onwards which audit trail is to be fetched.

 

N/A

DateTo

Root

Date up to which the audit trail is to be fetched.

 

N/A

UserIndex

Root

Index of the user for which the audit trail is to be fetched.

Integer > 0

N/A

AuditLogIndex 

Root 

It is an integer, which specifies the number starting from which the Objects are to be taken from the Records in the Result Set.

  

Integer >= 0 

0 

NoOfRecordsToFetch

Root

Specifies the Number of records to be fetched

Integer > 0

 

SortOrder

Root

Indicates whether search results are to be sorted in Ascending order or Descending order.

 

‘A’ – Ascending

‘D’- Descending

 

‘A’

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

NGOFetchAuditTrail

Status

Root

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

AuditLogs

Root

This tag contains all the audit trail records fetched.

AuditLog

AuditLogsRoot

This tag contains the information about a particular record ofall the  audit trail records fetched.

AuditLogId

AuditLog

Index of the Audit trail.

ActionId

AuditLog

Action Ids.

Category

AuditLog

Category of the audit trails information requested.

ActiveObjectId

AuditLog

Index of the object for which the audit trail is to be fetched.

ActiveObjectType

AuditLog

Type of the object e.g. F - folder,

D - document,

A – Actionitem etc.

SubsdiaryObjectId

AuditLog

Id of the Subordinate action performed on the given object.

SubsdiaryObjectType

AuditLog

Type of the object on which subsidiary action is performed.

Comment

AuditLog

Comments associated with the action performed.

ActionDateTime

AuditLog

Date and Time when the audit trail was generated.

UserIndex

AuditLog

Index of the user for which the audit trail was generated.

 

Errors returned from call

Code

Message

Comments

-50146

Invalid session.

The specified UserDBId is incorrect.

-50006

User account has expired.

The user’s account has expired.

-50010

User not alive.

The user who attempts to fetch the audit trail is not alive.

-50125

Cabinet has been locked for Administrative purposes.

The cabinet has been locked by some user for Administrative purposes.