API Alert

Read

Reads one or more Alerts, including alerts set in the future. If the 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	0 or empty	The Alert code

Return: Array [ Alert ]

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.Alert_API.ReadLive

Parameters:

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

Return: Array [ Alert ]

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

Create

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Alert.Alert_API.Create

Parameters:

Name	Type	Default	Description
LrtMessage	String		The Alert message
LrtDateTime	DateTime		Issue Date/Time of Alert

Return: success or error

Update

Updates an Alert

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Settings.Copyright.Copyright_API.Update

Parameters:

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

Return: success or error

Delete

Deletes an Alert

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Settings.Copyright.Copyright_API.Delete

Parameters:

Name	Type	Default	Description
LrtCode	Integer	The Alert code

Return: success or error