API Alert
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 : Admin PowerUser
Method: PxStat.System.Navigation.Alert.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 |
LrtTitle |
String | Alert title |
LrtWarningFlag |
Boolean | Indicates if this Alert relates to a Warning |
Reads one or more alerts but only if they are in the past
Authentication: Windows
Privilege : All
Method: PxStat.System.Navigation.Alert.Alert_API.ReadLive
Parameters:
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 |
LrtTitle |
String | Alert title |
LrtWarningFlag |
Boolean | Indicates if this Alert relates to a Warning |
Authentication: Windows
Privilege : Admin PowerUser
Method: PxStat.System.Navigation.Alert.Alert_API.Create
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
LrtTitle |
String | Alert title | |
LrtMessage |
String | The Alert message | |
LrtDateTime |
DateTime | Issue Date/Time of Alert | |
LrtWarningFlag |
Boolean | Indicates if this Alert relates to a Warning |
Return: success or error
Updates an Alert
Authentication: Windows
Privilege : Admin PowerUser
Method: PxStat.System.Settings.Copyright.Copyright_API.Update
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
LrtCode |
Integer | The Alert code | |
LrtTitle |
String | Alert title | |
LrtMessage |
String | The Alert message | |
LrtDateTime |
DateTime | Issue Date/Time of Alert | |
LrtWarningFlag |
Boolean | Indicates if this Alert relates to a Warning |
Return: success or error
| Name | Type | Description |
|---|---|---|
| `` | ||
| `` | ||
| `` |
Authentication: Windows
Privilege : PowerUser
Method: PxStat.System.Settings.Copyright.Copyright_API.Delete
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
| `` |
Return: Message.
