NGOGetAlarmReminderCount

This call is used to find out the number of Alarms and Reminders based on the specified criteria. User can specify whether to get the count of generated Alarms and Reminders or not. In the call output will be as mentioned below:

-1	- Object specified is not found.
0	- If no alarm and reminder is found for the criteria specified.
Count	- Actual count according to criteria specified.

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.	NGOGetAlarm ReminderCount.	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
SetForUser	Root	It is a flag used for getting Alarms, which are set for the User or set by the User.	Y Set for User, N Set by User	N
DocumentType	Root	It Specifies the Type of document.	I – Image N – Non Image A – Reserved
InformMode	Root	Reserved for internal use.		B
ObjectIndex	Root	The Index of the object for which the Alarm has been set.		N/A
ObjectType	Root	It indicates the Type of object.	D-Document F-Folder	D
AlarmGenerated	Root	It is a flag that indicates whether the Alarms have been generated or not.	Y – Alarm is generated. N – Alarm not Generated.
UserIndex	Root	The Index of the User for whom the Alarm has been set.
CurrentDateTime	Root	Current Date and Time at which call is made to the Server.	Valid Date in the format- yyyy-mm-dd hh:mm:ss	Current Date and Time of the Server.
GetAllForUser	Root	Specifies whether the Alarms and Reminders set for the User or set by the User who has logged in are to be considered.	'S' – All Reminders Set by currently logged in User irrespective of Date/Time. 'A' - All Reminders set for currently logged in User irrespective of Date/Time 'T' - All the Reminders, before given Time, set for currently logged in User. 'B' - All the Reminders in Batches, before given time, set for currently logged in User.	T
CountType	Root	Flag that specifies whether the count is for Alarms or Reminders or both.	R-Reminder A-Alarms B-Both	B-Both.

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.
AlarmCount	Root	It indicates the total number of Alarms fetched.
ReminderCount	Root	It indicates the total number of Reminders fetched.

Errors returned from call

Code	Message	Comments
-50074	Invalid_Parameter	Invalid Parameters are thrown when invalid parameters are given in the inputxml tag. For e.g. object type should be “F”,”D” or “B” or Alarm Generated should be either “Y” or “N” etc.