This call returns the list of Reminders set by the User or set for the logged in User based on GetAllForUser flag. All Reminders can be fetched at a time or they can be fetched in batches either on ascending or descending order of Date.
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOGetPending Reminders. |
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 |
|
CurrentDateTime |
Root |
It indicates the current Date and Time on the Server. |
|
Current Date Time. |
|
GetAllForUser |
Root |
Specifies whether the Alarms and Reminders set for the User or set by the User who has logged in are to be considered.
|
'S' – All Reminders Set by currently logged in User irrespective of Date/Time. 'A' - All Reminders set for currently logged in User irrespective of Date/Time. 'T'- All the Reminders, before given Time, set for currently logged in User. 'B' – All the Reminders in Batches, before given time, set for currently logged in use. |
T |
|
LastReminderIndex |
Root |
It indicates the index of the last Reminder in the Previous batch. |
|
0 |
|
LastReminderDate |
Root |
It indicates the date of the last Reminder in the Previous batch. |
|
|
|
SortOrder |
Root |
It indicates the Order in which Reminders are fetched. |
A – Ascending D – Descending |
A |
|
UserIndex |
Root |
It indicates the Index of the User for whom Reminders are fetched. |
|
|
|
InformMode |
Root |
Reserved for internal use. |
|
B |
|
DocumentType |
Root |
It indicates the Type of the document.
|
I – Image N – Non Image A – ActionItem (Reserved) |
|
|
NoOfRecordsToFetch |
Root |
The number of records to be fetched for the call. |
|
|
|
DocumentIndex |
Root |
The Index of the document for which Reminders are set. |
|
|
|
ReminderCountOnly |
Root |
It is a flag to indicate whether the OutputXml will bring the Reminder Count only or the details of the Reminders also. |
|
N |
|
ReminderType |
Root |
Type of the reminder. |
U – Untouched C – Completed |
U |
|
MailFlag |
Root |
Indicates whether the user is to be reminded through mail or not. |
Y or N |
N |
|
FaxFlag |
Root |
Indicates whether the user is to be reminded through fax or not. |
Y or N |
N |
|
RightsFlag |
Root |
Whether the login user’s rights are to be checked for the current operation. |
Y or N |
|
|
FlatReminderAlso |
Root |
It is a flag to indicate whether the general reminders are also to be fetched or not. |
Y–To be fetched N-Not |
Y |
|
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. |
|
TotalNoOfRecords |
Root |
It indicates the total number of records in a call. |
|
NoOfRecordsFetched |
Root |
It indicates the total number of Reminders fetched in a batch. |
|
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 Reminder. |
|
UserIndex |
Reminder |
It indicates the User Index for which Reminders are fetched. |
|
DocumentIndex |
Reminder |
It indicates the Index of the document. |
|
ReminderDateTime |
Reminder |
It specifies the Date and Time for which the Reminder is set. |
|
Comment |
Reminder |
Any comment associated with the Reminder. |
|
SetByUser |
Reminder |
User Index of the User who has set the Reminder. |
|
InformMode |
Reminder |
Reserved for internal use. |
|
DocumentName |
Reminder |
Name of the document for which Reminders are set. |
|
UserName |
Reminder |
It indicates the User Name for which Reminders are fetched. |
|
DocumentType |
Reminder |
Type of the document. |
|
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. |
|
ReminderType |
Reminder |
Type of the reminder. |
|
MailFlag |
Reminder |
Indicates whether the user is to be reminded through mail or not. |
|
FaxFlag |
Reminder |
Indicates whether the user is to be reminded through fax or not. |
|
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. |