ClientAlerts - RADplus web service
- Last updated
-
-
Save as PDF
The WEBSVC.ClientAlerts web service. This service contains the following calls:
- AddClientAlert
- GetClientAlerts
- EditClientAlert
- GetDictionaryItems
AddClientAlert Call
Parameters with no Properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
|
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
| ClientID |
N/A |
Client ID number |
|
Parameters with Properties
| Parameter |
Property |
Value Accepted |
Notes |
| ClientAlertObject |
ApplicableForms |
Dictionary field # 105 in RADplus_Client file |
List of forms for which the alert should display. |
| |
CustomMessage |
Free text |
|
| |
Disabled |
Dictionary field # 107 in RADplus_Client file |
|
| |
EndDate |
Date |
|
| |
Episodes |
Dictionary field # 106 in RADplus_Client field |
List of episodes on which to display the alert. |
| |
ForDateRange |
Dictionary field # 102 in RADplus_Client field |
|
| |
StartDate |
Date |
|
| |
TypeOfAlert |
Dictionary field # 100 in RADplus_Client field |
|
| |
Message |
Free text |
|
| |
Status |
Free text |
|
GetClientAlerts
Parameters with no Properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
|
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
| ClientID |
N/A |
Client ID number |
|
EditClientAlerts
Parameters with no Properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
|
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
| ClientID |
N/A |
Client ID number |
|
| ClientAlertID |
N/A |
A Client Alert identifier |
|
Parameters with Properties
| Parameter |
Property |
Value Accepted |
Notes |
| ClientAlertObject |
ApplicableForms |
Dictionary field # 105 in RADplus_Client file |
List of forms for which the alert should display. |
| |
CustomMessage |
Free text |
|
| |
Disabled |
Dictionary field # 107 in RADplus_Client file |
|
| |
EndDate |
Date |
|
| |
Episodes |
Dictionary field # 106 in RADplus_Client field |
List of episodes on which to display the alert. |
| |
ForDateRange |
Dictionary field # 102 in RADplus_Client field |
|
| |
StartDate |
Date |
|
| |
TypeOfAlert |
Dictionary field # 100 in RADplus_Client field |
|
| |
Message |
Free text |
|
| |
Status |
Free text |
|
GetDictionaryItems
Parameters with no Properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
|
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
