NGOSetAlarms

This call is used to set Alarms for a set of Users on an object. The object can be Document or Folder. User can also set the inform mode for the Alarm. Inform mode is the way by which the User is informed when the Alarm is generated. Presently two types of Inform modes are supported. They are Mail and Popup. Through this call only User Alarms can be set based on supported Action Types. To set an Alarm, the User who is setting the alarm and Users for whom the alarm is to be set must have Read Rights on the document. List of failed Alarms is returned in the output of the call. Warning is returned when some Alarm fails.

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.	NGOSetAlarms	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
Alarms	Root	A List of Alarms, starting from the root, is given between <Alarms> and </Alarms> tag.
Alarm	Alarms	Information about the alarms is given between the <Alarm> and </Alarm> tags.
AlarmType	Alarm	Specifies the Type of Alarms. i.e. SystemLevelAlarms or UserLevelAlarms	U-User S-System
ObjectType	Alarm	It indicates document or folder.	D-Document F-Folder	D
ObjectId	Alarm	It indicates the Index of the object for which Alarm has been set.		N/A
UserIndex	Alarm	The Index of the User for whom Alarm has been set.		N/A
ActionType	Alarm	It represents the Index of the action performed for the Alarm (for example, 2) for Document Delete	User level alarm 2 - Document Deleted 3 - Expiry Date on document is reached. 4 - Document Uploaded. 5 - Document Modified. 6 - Notes Added. 8 - Document Moved. 9 - Document Renamed. 10 - Document Shared. 12 - Document Checked In. 13 - Document Checked Out. System Level Alarms 1 –Space exhausted. 4- Document Added. 7-Back up taken.	N/A
Comment	Alarm	The comment associated with the Alarm.		Blank
InformMode	Alarm	Reserved for internal use.		B

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.
Alarms	Root	A List of Alarms, starting from the root, is returned between <Alarms> and </Alarms> tags.
Alarm	Alarms	Information about the Alarms that failed is returned between the <Alarm> and </Alarm> tags.
AlarmIndex	Alarm	Index associated with the Alarm.
ObjectName	Alarm	Name of the Folder or Document on which the alarm is set.
SetForUser	Alarm	User for which this alarm has been set.
Alarm Type	Alarm	Specifies the type of Alarms .e SystemLevelAlarms or UserLevelAlarms.
Object Type	Alarm	It indicates the type of object either document or folder.
Object Id	Alarm	The Index of the object for which the alarm has been set.
User Index	Alarm	The Index of the User for whom Alarm could not be set.
Action Type	Alarm	It represents the Index of the action performed for the Alarm.
~~Action Type~~Success Alarms	~~Alarm~~Root	~~It represents the Index of the action performed for the Alarm.~~It contains the list of successful alarms
Alarms	SuccessAlarms	It contains the information about the alarm.
Object Type	Alarm	Corresponds to Alarm Index.

Errors returned from call

Code	Message	Comments
-50133	Folder has been deleted.	When we try to set Alarm on a folder that has been deleted.
-50144	Invalid Alarm Action	When we try to set Alarms based on an ActionType that is not valid.
-50143	Invalid Alarm Object.	When we try to set Alarm on an object that is invalid.
-50132	Document has been deleted.	When we try to set Alarm on a document that has been deleted.
-50023	Document not found	When we try to set Alarm on a document that is not found.
-50017	Folder does not exist	When we try to set Alarm on a folder that does not exist.
-50412	Invalid Alarm Type	This exception is thrown when we specify invalid Alarm type in inputxml

Warnings returned from call

Code	Message	Comments
50007	Not All Alarms Set	Alarm for which User wants to set Alarm must have Rights on object. User must have atleast Read Rights on object to set an Alarm.