This call returns the list of
generated Alarms set for a User on an Object based on the Action type tag. It
is used for the purpose of sending mails. This call returns only those Alarms
whose inform mode is either both (B) or Mail (M). Only supervisor has the
rights to execute this call.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOGetAlarmsForMail |
|
|
CabinetName |
Root |
Name of the Cabinet to which the
User wants to connect. |
|
|
|
UserDBId |
Root |
UserDatabase ID that is returned in the NGOConnect Cabinet call. |
|
|
|
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 |
|
ActionType |
Root |
It represents the Index of the action performed for the
Alarm ex: 2 for Document Delete. |
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. |
|
|
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 is returned between the
<Alarm> and </Alarm> tags. |
|
AlarmIndex |
Alarm |
Unique Index of the Alarm. |
|
AlarmType |
Alarm |
It indicates the Type of Alarm i.e. User Level Alarm or
System Level Alarm. |
|
ObjectId |
Alarm |
The Index of the object ex can be document, folder. |
|
ObjectType |
Alarm |
It indicates document or folder. |
|
ActionType |
Alarm |
It indicates the type of action performed on object. |
|
AlarmGenerated |
Alarm |
It is a flag to indicate whether Alarm is generated or
not. |
|
AlarmDateTime |
Alarm |
Date and Time for which the Alarm was set. |
|
UserName |
Alarm |
Name of the User for whom the Alarm has been set. |
|
ObjectName |
Alarm |
It indicates the name of the object. |
|
SetByUser |
Alarm |
The index of the User who has set the Alarm. |
|
InformMode |
Alarm |
Reserved for internal use. |
|
DocumentType |
Alarm |
It indicates the type of the document. |
|
DocumentSize |
Alarm |
It specifies the size of the document in bytes. |
|
NoOfPages |
Alarm |
It indicates the no of pages of the document. |
|
CreatedByAppName |
Alarm |
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 #. |
|
VersionNo |
Alarm |
Version No. associated with the Alarm |
|
Comment |
Alarm |
Comment associated with the Alarm. |
|
Code |
Message |
Comments |
|
-50022 |
Invalid
Rights On Document |
Since it
is a Supervisor call, if one does not have Rights, it will throw Insufficient
Rights for the current operation. |
|
-50112 |
No Data Found
|
There is
no Alarm generated for which inform type is either M or B. |