NGOGetRemindersForMail

This call is used to get all reminders for a User on a document. It is used to remind Users through mail. It returns only those Reminders for which inform mode is either mail or both types.

 

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.

NGOGetReminders

ForMail

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

ReminderIndex

Root

It indicates the unique Index of the Reminder.

 

N/A

 

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.

Reminders

Root

A List of Reminders, starting from the Root, is returned between <Reminders> and </Reminders> tags.

Reminder

Reminders

Information about the Reminders is returned between the <Reminder> and </Reminder> tags.

ReminderIndex

Reminder

Unique Index of the Reminder.

UserIndex

Reminder

It indicates the Index of the User for whom Reminder has been set.

DocumentIndex

Reminder

The Index of the document on which Reminder has been set.

ReminderDateTime

Reminder

It specifies the Date and Time for which the Reminder is set

Comment

Reminder

It indicates any comment along with the Reminder.

DocumentName

Reminder

The name of the document on which Reminder has been set.

SetByUser

Reminder

It indicates the index of the User who has set the Reminder.

InformMode

Reminder

Reserved for internal use.

UserName

Reminder

Name of the User for whom Reminder has been set.

DocumentType

Reminder

Type of the document.

ISIndex

Reminder

Specifies a unique Combination of Image Index and Volume Index for a document stored on the Image Server separated by #. For example, 3#79

DocumentSize

Reminder

Size of the document in bytes.

NoOfPages

Reminder

No. of pages in the document.

CreatedByAppName

Reminder

Extension of the Document. For example JPG, GIF etc.

VersionNo

Reminder

Version no of the document for which the reminder was set.

 

Errors returned from call

Code

Message

Comments

-50112

No data found.

No Reminder has been generated for which inform mode is M or B.