NGOGetAllAlarms

This transaction is used to fetch all Alarms set by the User or set for the User on the basis of a flag. If GetAllForUser flag is Y, then all the Alarms set for the logged in User are returned otherwise, all Alarms set by the logged in User are returned.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml

Input Parameters description

Name	Parent Tag	Description	Valid Values	Default Values
Option	Root	Unique option for the call.	NGOGetAllAlarms	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 NGOConnectCabinet call.		N/A
GetAllForUser	Root	It is a flag used for getting Alarms that are set for the User or set by the User.	Y Set for User, N Set by User
DocumentType	Root	It Specifies the Type of document.	I – Image N – Non Image A – Reserved
ObjectIndex	Root	The Index of the object for which the Alarm has been set.
ObjectType	Root	It indicates the Type of object.	D-Document F-Folder	D
InformMode	Root	Reserved for internal use.		B
AlarmCountOnly	Root	Flag that specifies whether the details about all the Alarms generated is required	N – Gives the complete details about all the Alarms generated. Y – Does not give the actual details of the Alarms but gives the count only for the Alarms generated.	N
AlarmGenerated	Root	Whether the alarm has been previously generated or not.	Y Or N	Y
TargetUserIndex	Root	Index of the target user for which this alarm has been set.	Integer
LastAlarmIndex	Root	Index of the last alarm in the previous batch of alarms fetched.
NoOfRecordsToFetch	Root	No of Maximum records to be fetched from the database.
SortOrder	Root	This tells whether the list to be fetched in ascending or descending order.	A/D

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	Information about all the Alarms returned.
Alarm	Alarms	Information about specific Alarm.
AlarmIndex	AlarmRoot	Unique Index of the Alarm generated.
ObjectId	AlarmRoot	The Index of the object for which Alarm is fetched.
ObjectType	AlarmRoot	It indicates the Type of object.
ActionType	AlarmRoot	It indicates the type of action performed on object.
AlarmGenerated	AlarmRoot	It is a flag to indicate whether Alarm is generated or not.
ObjectName	AlarmRoot	It indicates the name of the object.
InformMode	AlarmRoot	Reserved for internal use.
SetByUser	AlarmRoot	It indicates the name of the User who has set the Alarm.
NoOfPages	AlarmRoot	No of pages in the document.
CreatedByAppName	AlarmRoot	It indicates the extension of the document.
ISIndex	Alarm	Specifies a unique Combination of Image Index and Volume Index for a document stored on image server separated by #. For example, 3#79
DocumentType	AlarmRoot	It Specifies the Type of document.
DocumentSize	AlarmRoot	Size of the document in bytes.
AlarmDateTime	Alarm	Date and Time for which the Alarm was set.
SetForUser	Alarm	User for whom the alarm has been set.
Username	Alarm	Name of the User for whom the Alarm has been set.
VersionNo	Alarm	Version number of the document.
Comment	Alarm	Comments associated with the object.
AlarmType	AlarmRoot	It indicates the type of Alarm i.e. User Level Alarm or System Level Alarm.
UserIndex	Alarm	Index of the user who set the alarm.
AlarmCount	Root	Count of all the Alarms that are present.
NoOfRecordsFetched	Root	No of records fetched from the database.
TotalNoOfRecords	Root	This is one more than the NoOfRecordsFetched if there are more records in the database else it is same.