Knowledgebase : Technical Support > API > Client API's/VTL > VertexFX Client WCF Service. > VertexFX Client WCF Service
SYNTAX
Public function GetAlerts (AccountID As Integer)
Description
The GetAlets operation is used to get a list of alerts that already
opened on specific account number
REQUEST PARAMETERS
Name
Description
Required
AccountID
* Accou...
SYNTAX
Public function DeleteAlert(AlertID As Integer, AlertType As Integer)
DESCRIPTION
The DeleteAlert operation is used to Update a given alert number that
takes on a specific accounts
REQUEST PARAMETERS
Name
Description
Required
A...
SYNTAX
Public function UpdateAlert(AccountID As Integer, AlertID As Integer, SymbolID As Integer, Condition As Integer, Value As Double, AlertType As Integer, Enabled As Boolean)
DESCRIPTION
The UpdateAlert operation is used to Update a given alert nu...
SYNTAX
Public function NewAlert(AccountID As Integer, SymbolID As Integer, Condition as Integer, Value as Double, AlertType as Integer)
Description
The NewAlert operation is used to create a new alert on a specific
symbol for a given account number.
...
SYNTAX
Function GetChartScrollData(Symbol As String, PeriodID As Long,BeforeDate As String, RowsNumber As Long) As String
REQUEST PARAMETERS
Name
Description
Required
Symbol
* Symbol Identifier to get it chart data for
* Type : ...
SYNTAX
ChangePassword(OldPW As String, NewPW As String, ConfirmNewPW As String) As String
DESCRIPTION
The ChangePassword operation is used to change the logged in client
password with new one.
REQUEST PARAMETERS
Name
Description
Required
...
to be added with 10.6
SYNTAX
GetMWNewTick ()
DESCRIPTION
The GetMWNewTick operation is used to get the market watch symbol data
if changed and returns a list of symbols
which holds all symbols with their corresponding Bid/Ask, High/Low.
NOTE: This operation does not requi...
SYNTAX
GetMWSymbols()
DESCRIPTION
The GetMWSymbols operation is used to get market watch symbol setting
without the need to login to the
session.
REQUEST PARAMETERS
No Requested Parameters.
RESPONSE ELEMENTS
Name
Description
Result
This...
SYNTAX
SendSMTPEmail (ToMail As String, CCMail As String, BCCMail As String, MailSubject As String, MailBody As String, ServerSerial As String )
DESCRIPTION
The SendSMTPEmail operation is used to send an email to a specific
email address.
REQUEST PA...
SYNTAX
GetStmtHeaderFooter ()
DESCRIPTION
The GetStmtHeaderFooter operation is used to get the statement header
and statement footer for the logged-in client.
REQUEST PARAMETERS
No requested parameters.
RESPONSE ELEMENTS
Name
Description
...
SYNTAX
getClientGMT ()
DESCRIPTION
The getClientGMT operation is used to get the GMT value for the
logged-in client.
REQUEST PARAMETERS
No requested parameters.
RESPONSE ELEMENTS
Name
Description
Result
* In case of success, it will...
SYNTAX
GetDeliveryItemsGet( SymID As String )
DESCRIPTION
The GetDeliveryItemsGet operation is used to get the delivery Item
information for the given delivery symbol ID.
REQUEST PARAMETERS
Name
Description
Required
SymID
* The Sy...
SYNTAX
GetPendingOrdersWithMO ( AccountId As Long )
DESCRIPTION
The GetPendingOrdersWithMO operation is used to return a list of type
(pendingOrders) which holds a given account market order in pending
mode.
REQUEST PARAMETERS
Name
Description...
SYNTAX
Function DeliverSymbol(AccountId As Integer, Symbol As Integer, BuySell As Integer, Items As String, TotalAmount As Double, TicketID As Integer, DeptID As Integer, Optional ByVal note As String = "") As String
DESCRIPTION
The DeliverSymbol ope...
SYNTAX
Logout()
DESCRIPTION
The Logout method used to disconnect the client session.
REQUEST PARAMETERS
Logout operation has no request parameters.
RESPONSE ELEMENTS
Name
Description
Result
This operation returns a Composite JSON object...
Market Order Types
Description
Code
Buy
1
Sell
-1
-------------------------
SEE ALSO
* Chart Periods
[http://www.hybridsolutions.com/support/index.php?/Knowledgebase/Article/View/2700]
* Common Errors and Constants
[http://www...
Chart Periods
Description
Code
One minute
1
Five minutes
2
Fifteen minutes
3
Thirty minutes
4
One hour
5
Five ours
6
Daily
7
Weekly
8
Monthly
9
-------------------------
SEE ALSO
...
SYNTAX
GetGlobals()
DESCRIPTION
The GetGlobals operation is used to retrieve some global info as
listed below in response elements table.
REQUEST PARAMETERS
This operation takes no parameters.
RESPONSE ELEMENTS
Name
Description
Result
I...
SYNTAX
GetClient()
DESCRIPTION
The GetClient operation is used to return all client’s data needed
including accounts list and child clients list,
needed to build your client’s tree after logging on.
REQUEST PARAMETERS
This operation takes no paramet...
SYNTAX
GetReflection( AccID As Long )
DESCRIPTION
The GetReflection operation is used to retrieve all account updates
flags, So needed to make all account data current and up to date for
the current logged in client.
REQUEST PARAMETERS
Name
De...
SYNTAX
GetRequotedOrders ()
DESCRIPTION
The GetReqoutedOrders operation is used to retrieve the orders which
have been re-quoted by a dealer for the selected account.
DEPENDENCIES
You might use this operation based on the result of the
GetAccountRef...
Transaction Types
Description
Code
Closing Position
L : liquidation
For Limit Order Type
Check Limit Order Type
[http://www.hybridsolutions.com/support/index.php?/Knowledgebase/Article/View/1969]
For Money
* DP: Deposit
* WD...
Limit Order Types
Name
Numeric Code
Character Code
Buy Limit
1
BL
Buy Stop
2
BS
Sell Limit
-1
SL
Sell Stop
-2
SS
-------------------------
SEE ALSO
* Transaction Types
[http://www.hybridsolutions.co...
Client Symbol Parameter Types
Name
Code
SpreadType
1
LimitOffsetType
2
StopOffsetType
3
InitialMarginReqType
4
MaintenanceMarginReqType
5
VisibleType
6
CommessionType
7
MaxLotsType
8
MinLo...
Client General Parameter Types
Name
Code
EnableNews Type
100
EnableInterest Type
102
LiquidationType Type
103
LiquidationPoint Type
104
AccountIDPrefix Type
105
AccountIDPostfix Type
106
GMTOfsset Type
...
Spread Types
Name
Code
From Bid Spread
1
From Average Spread
2
-------------------------
SEE ALSO
* Client General Parameter Types
[http://www.hybridsolutions.com/support/index.php?/Knowledgebase/Article/View/1967]
* Client Sym...
Reflection Flags
Name
Code
CloseOpenPositionRef
1
DealerChangeFuturePrice
2
DeleteClosePositionRef
3
DeleteOpenPositionRef
4
LiqUpdated
5
HistoryUpdated
6
LimitSLTPOrdersUpdated
7
SummeriesRef
...
Common Errors and Constants
Name
Code
Description
TradingIsClosedError
-5
Trading session is closed
OrderAlreadyProcessed
-6
Request order is already processed
NotEnoughMoneyError
-2
Not enough money to make a posit...
SYNTAX
GetOrderPL (AccountID As Long , PosID as Long )
DESCRIPTION
The GetOrderPL operation is used to get a Position Profit/Loss at
request time for a specific Position ID which belongs to a specific
account.
REQUEST PARAMETERS
Name
Descripti...
SYNTAX
CreateDemoAccount ( fname As String, tel As String , email As String , address As String , deposit As Double , country As String , IPAddress As String )
DESCRIPTION
The CreateDemoAccount operation is used to generate a new account for
demonstra...
SYNTAX
DeleteMail ( MailID As Long )
DESCRIPTION
The DeleteMail operation is used to delete mail message specified by a
mail identifier.
DEPENDENCIES
In order to obtain MailID you’ll need to invoke GetMails
[http://www.hybridsolutions.com/support/in...
SYNTAX
ReadMail ( MailID As Long )
DESCRIPTION
The ReadMail operation is used to Read mail message specified by email
identifier.
DEPENDENCIES
In order to obtain MailID you’ll need to invoke GetMails
[http://www.hybridsolutions.com/support/index.php...
SYNTAX
GetDepartments ()
DESCRIPTION
The GetDepartments operation is used to return all BackOffice
departments as List (of type Department) that will receive client
email.
REQUEST PARAMETERS
The GetDepartments operation has no request parameters.
...
SYNTAX
SendMail (DeptIDs () As Long, MailContent As String, MailSubject As String )
DESCRIPTION
The SendMail operation used to send a mail message to a specific
Department in the Backoffice.
DEPENDENCIES
In order to obtain departments ID’s you’ll ne...
SYNTAX
GetMails()
DESCRIPTION
The GetMails operation is used to return all Messages that belong to
the logged in client.
REQUEST PARAMETERS
The GetMails operation has no request parameters.
RESPONSE ELEMENTS
Name
Description
Result
Th...
SYNTAX
UpdateSLTP( AccId As Long, OrderId As Long, lots As Double , SL As Double, TP As Double)
DESCRIPTION
The UpdateSLTP operation is used to update lots, SL and TP for a given
account identifier and order identifier.
REQUEST PARAMETERS
Name
...
SYNTAX
UpdateLimitOrder (AccId As Long , OrderId As Long, Price As Double , Lots As Double , SL As Double , TP As Double , Optional Note As String = "")
DESCRIPTION
The UpdateLimitOrder operation is used to updates the price, lots, SL
and TP for a giv...
SYNTAX
GetAccountSumm(AccId As Long)
DESCRIPTION
The GetAccountSumm operation is used to return the account details as
listed below in response elements.
REQUEST PARAMETERS
Name
Description
Required
AccId
* The intended account iden...
SYNTAX
NewOrder( AccountId As Long, Symbol As Integer , BuySell As Integer , Lots As Double, Optional Note As String )
DESCRIPTION
The NewOrder operation is used to place a new market order at the
specific given account number.
REQUEST PARAMETERS
...
SYNTAX
NewManageSLTP( AccId As Long , OrderId As Long , Lots as Double , TP As Double , SL As Double)
DESCRIPTION
The NewManageSLTP operation is used to places new Stop Loss/Take
profit at specific position for the specific given
account number.
REQU...
SYNTAX
NewLimitOrder (AccountId As Long , SymID As Integer , LimitType As Integer, Price As Double , Lots As Double , SL As Double ,TP As Double , Optional Note As String = "")
DESCRIPTION
The NewLimitOrder operation is used to replace the new limit /...
SYNTAX
Login (username As String, password As String)
DESCRIPTION
The Login operation should be called before any other operation. Since
any requesting operation have to be authenticated
before.
REQUEST PARAMETERS
Name
Description
Required...
SYNTAX
GetChartData (Symbol As String, PeriodID As Long, AfterDate As String)
DESCRIPTION
The GetChartData operation is used to return a JSON object as a list
(of type ChartCandle) which contains a given symbol
historical data based on the specified p...
SYNTAX
GetPrivateNews()
DESCRIPTION
The GetPrivateNews operation is used to return the news content which
set by Backoffice dealer for specific client.
REQUEST PARAMETERS
The GetPrivateNews operation has no request parameters.
RESPONSE ELEMENTS
...
SYNTAX
GetPublicNews ()
DESCRIPTION
The GetPublicNews operation is used to return the news content which
set by Backoffice dealers for public.
REQUEST PARAMETERS
The GetPublicNews operation has no request parameters.
RESPONSE ELEMENTS
Name
...
SYNTAX
GetUnits ()
DESCRIPTION
This function used to get all defined amount of units for the logged
in client.
REQUEST PARAMETERS
The GetUnits operation has no request parameters.
RESPONSE ELEMENTS
Name
Description
Units
The GetUnit...
SYNTAX
GetSymbol (Symbol As String)
DESCRIPTION
The GetSymbol operation is used to return symbol identifier if symbol
name was given, or returns symbol name if given symbol identifier.
REQUEST PARAMETERS
Name
Description
Required
Symbol
...
SYNTAX
GetAccountStmt (AccountId As Long,FromDate As String ,ToDate As String)
DESCRIPTION
The GetAccountStatement operation is used to return a JSON object of
type string array which contains a given account statement between
the starting date and en...
SYNTAX
GetPendingOrders (AccountId As Long)
DESCRIPTION
The GetPendingOrders operation is used to return a List (of Type
pendingOrders) which holds a given account pending
orders (limit/manage orders).
REQUEST PARAMETERS
Name
Description
R...
SYNTAX
GetOpenPositions (AccountId As Long)
DESCRIPTION
The GetOpenPositions operation is used to return a List (of
Position(s)) which holds a given account open positions.
REQUEST PARAMETERS
Name
Description
Required
AccountId
* Th...
SYNTAX
GetOpenPositions_stmt(AccountId As Long,FromDate As String ,ToDate As String )
DESCRIPTION
The GetOpenPositions_stmt operation is used to return a list of
positions which contains a given account open positions between a
given starting date a...
SYNTAX
GetNewTick ()
DESCRIPTION
The GetNewTick operation checks if any symbol data changed and returns
a list of Symbols which contains all symbols
with their corresponding Bid/Ask, High/Low.
REQUEST PARAMETERS
The GetNewTick operation has no requ...
SYNTAX
GetHistory(AccountId As Long, FromDate As String, ToDate As String, isPaging As Boolean, lastXdays As Integer)
DESCRIPTION
The GetHistory operation is used to return a list which contains a
given account history of a given starting date and
end...
SYNTAX
GetClientGeneralParams (ParamType As Integer)
DESCRIPTION
The GetClientGeneralParam operation is used to return the value for a
given parameter name which is specified for the logged in client.
REQUEST PARAMETERS
Name
Description
R...
SYNTAX
GetAllSymbols (AccountID As Long, Optional WithGroups As Boolean = False)
DESCRIPTION
The GetAllSymbols operation is used to return a List of symbols for
the logged in client according to the given account id parameter.
REQUEST PARAMETERS
...
SYNTAX
GetAccounts ()
DESCRIPTION
The GetAccounts operation is used to return account info for the
logged-in client.
REQUEST PARAMETERS
The GetAccounts operation has no request parameters.
RESPONSE ELEMENTS
Name
Description
Result
Th...
SYNTAX
GetAccountTransactions(AccountId As Long , FromDate As String, ToDate as String)
DESCRIPTION
The GetAccountTransactions operation returns a 2 Dimensional String
array which holds a statement of the closed transactions data
Request Parameters
...
SYNTAX
CancelSLTP (AccountId As Long , OrderId As Long)
DESCRIPTION
The CancelSLTP operation is used to delete a SLTP order at the
specific given account number.
REQUEST PARAMETERS
Name
Description
Required
AccountId
* The intended ...
SYNTAX
CancelLimitOrder (AccountId As long, OrderId As Long)
DESCRIPTION
The CancelLimitOrder operation is used to deletes a limit order at the
specific given account number.
REQUEST PARAMETERS
Name
Description
Required
AccountId
* ...
SYNTAX
CloseByHedge (Ticket1 As long, Ticket2 As Long, AccountID As Long, Lots As Double)
DESCRIPTION
The CloseByHedge operation is used to close a buy position with a sell
position fully or partially with the same symbol if hedging is
allowed.
Re...
SYNTAX
CloseOrder (AccountId As Long, Lots As Double, TicketId As Long)
DESCRIPTION
The CloseOrder operation is used to close fully or partially an open
position for a specific account number.
REQUEST PARAMETERS
Name
Description
Required
...
SYNTAX
ClientRejectOrder (AccountID As Long , OrderID As Long)
DESCRIPTION
The ClientRejectOrder operation is used to reject a re-quoted order
at a specific account number.
DEPENDENCIES
In order to obtain the requoted orders, you’ll need to
invoke G...
SYNTAX
ClientAcceptOrder (AccountID As Long, OrderID As Long)
DESCRIPTION
The ClientAcceptOrder operation is used to accept a re-quoted
order at a specific account number.
DEPENDENCIES
In order to obtain the requoted orders, you’ll need to
invoke Ge...
REQUIRED KNOWLEDGE AND SKILLS
Use of this guide assumes you are familiar with the following:
* XML.
* JSON objects.
* Basic understanding of WCF services.
* A programming language for consuming a web service and any related
tools.
-----------...
Help Desk Software by Hybrid Solutions