NGOSetReminder

This transaction is used to set Reminder for a set of Users on an object. Reminder facility is only supported for document. User can also set the inform mode for the Reminder.  The inform mode is the way by which Users will be informed when the Reminder is generated. Presently two type of Inform modes are supported either Mail Or Popup. A Reminder is generated when the specified time elapses. Set Reminder call returns a warning if any Reminder could not be sent otherwise it gives the Reminder Index of all successful Reminders.

 

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.

NGOSet

Reminder

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

RightsFlag

Root

Indicates whether rights checking would be performed or not.

‘Y’ – Yes

‘N’ - Yes

 

Reminders

Root

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

 

N/A

Reminder

Reminders

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

 

N/A

UserIndex

Reminder

The Index of the User for which the Reminder is set.

 

N/A

ReminderDate

Time

Reminder

It specifies the Date and Time for which the Reminder is to be set.

 

Reminder

DateTime on the database Server.

DocumentIndex

Reminder

The Index of the document for which the Reminder is to be set.

 

N/A

InformMode

Reminder

Reserved for internal use.

 

B

Comment

Reminder

Specifies any comment associated with the Reminder.

 

Blank

ReminderType

Reminder

New Reminder type to be set for the specified reminder.

‘U’ – Untouched

‘C’ - Completed

‘U”

SetByUser

Reminder

User by whom the reminder is being set.

 

 

MailFlag

Reminder

This flag indicates whether a mail is to be sent on the stipulated time.

 

‘Y’ – Yes

‘N’ – No

N

FaxFlag

Reminder

Fax flag associated with the reminder.

 

‘Y’ – Yes

‘N’ - No

N

 

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

Contains all the modified reminders.

Reminder

Reminders

Indicates the modified reminders.

ReminderIndex

RootReminder

Unique Index of the Reminder set.

ReminderDateTime

RootReminder

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

 

Errors returned from call

Code

Message

Comments

-50023

Document not Found

When we try to set Reminder on a document, which is not found.

-50074

Invalid Parameter.

When we specify InformMode apart from P, M or B.

-50132

Document has been deleted.

When we try to set Reminder on a document, which does not exist.

 

Warnings returned from call

Code

Message

Comments

50006

Not All Reminders Set

When we have no Rights on a document for which we set the Reminder.