NGOGetDivert

This call fetches the list of diverted documents.

 

Input Parameter description

View Sample InputXml

Output Parameter description

View Sample OutputXml

 

Input Parameters description

Name

Parent Tag

Description

Valid Values

Default

Values

Option

Root

Unique option for the call

NGOGetDivert

N/A

CabinetName

Root

Name of the Database cabinet to which user wants to connect.

 

N/A

UserDBId

Root

UserDatabse ID, which is returned in the NGOConnect

Cabinet call

 

N/A

UserIndex

Root

Index of the user for which the list of diverted documents is to be brought.

 

 

DataDefIndex

Root

Index of the data definition associated with diverted documents.

 

 

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

Unique option for the call

Status

Root

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

DivertActions

Root

It is a container tag which contains the list of various documents of a particular user that are diverted.

DivertAction

DivertActions

It is an outer tag, which contains the information about a particular document that was diverted.

UserIndex

DivertAction

Index of the user from whose Inbox documents were diverted.

DataDefIndex

DivertAction

Index of the data definition attached to the document that was diverted.

DivertedUserIndex

DivertAction

Index of the user to which the document was diverted.

DurationFlag

DivertAction

Flag, which specifies whether there was some specific period for which the diversion action was performed.

Y – Diversion was performed for a specific period

N – Diversion was performed for indefinite period

FromDate

DivertAction

Date when the diversion of documents started.

ToDate

DivertAction

Date upto which the diversion will take place.

LeaveCopy

DivertAction

Flag, which specifies whether the copy of the documents diverted was kept with the user whose documents, were diverted.

Y – Copy of the documents diverted was also made in the inbox of the user whose documents were diverted.

N – Copy of the documents diverted was not made in the inbox of the user whose documents were diverted.

Confidential

DivertAction

Not Used

InformByEmail

DivertAction

Flag, which specifies whether to inform by mail to diverted user when an ActionItem is diverted