Syntax
Public function UpdateAlert(AccountID As Long, AlertID As Long, SymbolID As Long, Condition As Long, Value As Decimal, AlertType As Long, Enabled As Boolean)
Description
The UpdateAlert operation is used to Update a given alert number that takes on specific accounts.
Request Parameters
| Name |
Description |
Required |
| AccountId |
- AccountID to whom you want to create a new alert for
- Type: Long
- Default: None
- Constraints: Must be valid Account ID and accessible by logged-in Session
|
Yes |
| AlertID |
- The number of alerts that wants to update it
- Type: Long
- Default: none
- Constraints: Must be valid Alert ID and accessible by the provided Account number
|
Yes |
| SymbolID |
- Symbol identifier to create a new Alert on
- Type: Long
- Constraints: Must be valid, used Symbol Id
|
Yes |
| Condition |
- The condition that the alert will hit according on
- Type: Integer
- Constraints: Must be one of the following :
1: Bid Greater
2: Bid Less
3: Ask Greater
4: Ask Less
5: Balance Greater
6: Balance Less
7: Equity Greater
8: Equity Less
9: Margin level Greater
10: Margin Level Less
11: Profit loss Greater
12: Profit loss Less
|
Yes |
| Value |
- The condition that the alert will hit on
- Type is Double
|
Yes |
| AlertType |
- The type of the alert
- Type: Integer
- Constraints: Must be one of the following :
1: means Sound Alert
2: means SMS Alert
|
Yes |
| Enabled |
- To indicate if the alert has been enabled or not
- Type: Boolean
|
Yes |
Response Elements
| Name |
Description |
| Result |
The operation return Alert in case of success, otherwise an explicit error code is returned when the alert Id is less than 0
The Following are the Alert data member:
- Id
- SymbolId
- Condition
- Type
- Value
- Enabled
- HitTime
- HitPrice
- LastHitTime
- LastHitPrice
- IsSummaryAlert
|
See Also
GetDelivaryItem
getClientGMT
GetStmtHeaderFooter
VertexFX WCF Service Index