NGOModifyReminderExt

This transaction can be used to modify a list of reminders. You can modify the reminder time or other properties of the reminders. It returns the status for the call along with the properties of the reminders thus modified.

 

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

NGOModify

ReminderExt

 

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

Reminders

Root

Contains all the reminders to be modified.

 

N/A

Reminder

Reminders

Indicates the reminder to be modified.

 

N/A

Document

Index

Reminder

New document index to be set for the given reminder.

Integer > 0

N/A

ReminderIndex

Reminder

Index of the Reminder to be modified.

  

  

UserIndex

Reminder

User index for which the reminder is set.

 

N/A

ReminderType 

Reminder 

New Reminder type to be set for the specified reminder. 

‘U’ – Untouched

‘C’ - Completed 

‘U” 

UserIndex

Reminder

User index for which the reminder is set.

 

N/A

Comment

Reminder

New comments added to the reminder on reminder date time.

 

N/A

ReminderDateTime

Reminder

New reminder date time.

 

N/A

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

NGOModifyReminderExt

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

Reminder

Index of the reminder modified.

UserIndex

Reminder

User for whom the reminder is set now.

DocumentIndex

Reminder

Document index on which the reminder is set.

DocumentName

Reminder

Document name on which the reminder is set.

ReminderDateTime

Reminder

New reminder date time.

Comment

Reminder

Comments associated with the reminder.

SetByUser

Reminder

User index by which the reminder is set.

InformMode

Reminder

This flag indicates how the user will be informed of the reminder.

P – Pop Up

M – Mail

B – Both

ReminderType

Reminder

Type of the reminder.

MailFlag

Reminder

Mail flag of the reminder.

FaxFlag

Reminder

Fax flag of the reminder.

UserName

Reminder

Name of the user.

 

Errors returned from call

Code

Message

Comments

-50146

Invalid session.

The specified UserDBId is incorrect.

-50006

User account has expired.

The account of the user has expired.

-50010

User not alive.

The user is not alive.

-50125

Cabinet has been locked for Administrative purposes.

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

-50023

Document not found.

The specified document does not exist.

-50132

Document has been deleted.

The specified document has been deleted.

-50074

Invalid parameters.

The value for some input parameter is not correct or is invalid.

-50191

Reminder not set.

The requested reminder could not be set.

-50022

Insufficient rights for the current operation.

The logged-in user has insufficient rights on the specified document.

-50150

Invalid date for Reminder.

The specified reminder date is invalid.

-50058

Specified user does not exist.

The targeted user does not exist.

-50063

Specified user has expired.

The targeted user’s account has expired.

-50064

Specified user is not alive.

The targeted user is not alive.