Overview
This article contains documentation for the Alert web service and all related API calls.
For more information about all available Web Services and corresponding methods, refer to the Introduction to Web Services article.
Information
This web service includes the following methods:
getFiredAlerts
This service method allows fired alerts to be retrieved for a specified time range.
Method Signature
|
Ordinal |
DataType |
Required |
Description |
|---|---|---|---|
|
StartDate |
SvDate |
Yes |
The starting date and time for the requested range of results. The query returns changes including the specified start time. The time date format must be provided in the following format: yyyy-MM-dd HH:mm:ss.SSS For example, a start time of 1:50 PM on January 28th, 2004 would be 2004-01-28 13:50:00.000 |
|
EndDate |
SvDate |
Yes |
Ending date for the range of results. The query returns changes up to BUT NOT including the specified end time. The time date format must be provided as: yyyy-MM-dd HH:mm:ss.SSS |
|
Return Result |
SvFiredAlert |
No |
An array of SvAlert |
|
Field |
DataType |
Comments |
|---|---|---|
|
Address |
SvAddress |
Address Object |
|
Alertdescription |
String |
The text description of the alert |
|
alertType |
String |
The Type of the alert that fired |
|
Coordinate |
SvCoordinate |
The coordinate object of where the alert fired |
|
Criteriadescription |
String |
The rules of the alert that fired |
|
Message |
String |
The text of the message that was recorded for the fired alert |
|
Name |
String |
The name of the fired alert |
|
Priority |
String |
The priority of the fired alert |
|
receivedTime |
SvDate |
The time when the item that triggered the alert was received by the server. |
|
timecardName |
String |
Timecard status of the corresponding worker (On Duty/Logged Out/Logged In/Off Duty/On Break). |
|
triggeredTime |
SvDate |
The date and time when the item that triggered the alert actually happened at. |
|
workerName |
String |
The name of the worker who triggered the alert. |
getFiredAlertsByWorker
This service method allows fired alerts to be retrieved for a specified time range and a specified worker.
Method Signature
|
Ordinal |
DataType |
Required |
Description |
|---|---|---|---|
|
StartDate |
SvDate |
Yes |
The starting date and time for the requested range of results. The query returns changes including the specified start time. The time date format must be provided in the following format: yyyy-MM-dd HH:mm:ss.SSS For example, a start time of 1:50 PM on January 28th, 2004 would be 2004-01-28 13:50:00.000 |
|
EndDate |
SvDate |
Yes |
Ending date for the range of results. The query returns changes up to BUT NOT including the specified end time. The time date format must be provided as: yyyy-MM-dd HH:mm:ss.SSS |
|
WorkerName |
String |
Yes |
The username for a valid worker in the application. |
|
Return Result |
SvFiredAlert |
No |
An array of SvAlert |
getFiredAlertsByDivision
This service method allows fired alerts to be retrieved for a specified time range and specified divisions (Groups).
Method Signature
|
Ordinal |
DataType |
Required |
Description |
|---|---|---|---|
|
StartDate |
SvDate |
Yes |
The starting date and time for the requested range of results. The query returns changes including the specified start time. The time date format must be provided in the following format: yyyy-MM-dd HH:mm:ss.SSS For example, a start time of 1:50 PM on January 28th, 2004 would be 2004-01-28 13:50:00.000 |
|
EndDate |
SvDate |
Yes |
Ending date for the range of results. The query returns changes up to BUT NOT including the specified end time. The time date format must be provided as: yyyy-MM-dd HH:mm:ss.SSS |
|
Divisions |
String[] |
No |
List of divisions for which alerts will be returned. |
|
Return Result |
SvFiredAlert |
No |
An array of SvAlert |