API Alert

Home / API / Alert

Read.

Reads one or more Alerts, including alerts set in the future. If the Alert Code LrtCode parameter is passed in, then only that Alert will be returned. Otherwise, all Alerts are returned.

Authentication: Windows

Privilege : Administrator , PowerUser

Method: PxStat.System.Navigation.Alert_API.Read

Parameters:

Name	Type	Default	Description
LrtCode	Integer	null	The Alert Code

Return: Array [ Object ]

Name	Type	Description
LrtCode	Integer	The Alert code
LrtDatetime	DateTime	The Time and Date of the Alert
LrtMessage	String	The Alert Message

---

ReadLive.

Reads one or more alerts but only if they are in the past.

Authentication: Windows

Privilege : Administrator , Moderator , Power User

Method: PxStat.System.Navigation.Alert_API.ReadLive

Parameters:

Name	Type	Default	Description
LrtCode	Integer	0 or empty	The Alert Code

Return: Array [ Object ]

Name	Type	Description
LrtCode	Integer	The Alert code
LrtDatetime	DateTime	Issue Date/Time of Alert
LrtMessage	String	The Alert message

---

Create.

Creates an Alert.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Alert_API.Create

Parameters:

Name	Type	Default	Description
LrtMessage	String		The Alert Message
LrtDateTime	DateTime ('YYYY-MM-DDTHH:mm:ss')		Issue Date/Time of Alert (2018-12-31T00:00:00)

Return: String with value of success

---

Update.

Updates an Alert.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Alert_API.Update

Parameters:

Name	Type	Default	Description
LrtCode	Integer	The Alert Code
LrtMessage	String		The Alert Message
LrtDateTime	DateTime ('YYYY-MM-DDTHH:mm:ss')		Issue Date/Time of Alert

Return: String with value of success

---

Delete.

Deletes an Alert.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Alert_API.Delete

Parameters:

Name	Type	Default	Description
LrtCode	Integer	The Alert Code

Return: String with value of success