Knowledgebase : Technical Support > API > BackEnd API's/VBL > Backoffice API > Methods
SYNTAX Public Function ManualUpdateOpenPosition(AccountID as Integer, TicketID As Integer, NewLots As Double, NewPrice As Double, NewType As OperationTypeEnum, NewInterest As Double , NewComment As String) as CallingResultsEnum  DESCRIPTION The manual ...
Syntax Public Function CloseAllByHedge(AccountID As Integer, BuyTickets As String, SellTickets As String, BuyLots as String, SellLots as String, SymbolID as Integer) CallingResultsEnum DESCRIPTION The CloseAllByHedge function is used to close the given...
SYNTAX  Public Function GetDepartments() As CallingResultsEnum  DESCRIPTION This function is used to get all departments that the logged in dealer has a privilege on it After the GetDepartments method executes the DepartmentsResultReceived [http://www....
SYNTAX  Public Function ChangeDealerParameter(DealerID As Integer, ParameterLevel As DealerParamTypeEnum, parameter As String, InheritValue As Boolean, NewValue As String) As CallingResultsEnum  DESCRIPTION This function is used to change the symbol, g...
SYNTAX  Public Function GetSymbolDealerParam(DealerID As Long) As CallingResultsEnum  DESCRIPTION This function used to get the dealer symbol parameters for the given dealer ID. After GetSymbolDealerParam executed the DealerSymbolParameterResultReceive...
SYNTAX  Public Function GetPrivDealerParam(DealerID As Long) As CallingResultsEnum  DESCRIPTION This function is used to get the dealer privilege parameters for the given dealer ID, After GetPrivDealerParam executed the DealerPrivilegeParameterResultRe...
SYNTAX  Public Function GetGeneralDealerParam(DealerID As Integer) As CallingResultsEnum  DESCRIPTION This function is used to Get the general Parameter for the given dealer ID , After GetGeneralDealerParam executed the DealerGeneralParameterResultRece...
SYNTAX  Public Function UpdateDealerInfo(DealerID As Integer, Username As String, Password As String, ClientID As Integer, GMTOffset As String, DealerDesc As String, DealerTreePriv As Integer,Optional IsBranch As Boolean = False) As CallingResultsEnum  ...
SYNTAX  Public Function CreateDealer(ParentUsername As String, vDealerType As DealerType, Username As  String, Password As String, ClientID As Integer, DealerDesc As String, GMTOffset As String,DealerTreePriv As Long ,Optional IsBranch As Boolean = False...
SYNTAX  Public Function GetFloatingStatus (ClientID As Integer) As CallingResultsEnum  DESCRIPTION This function is used to get the floating status which belongs to the given client number. After GetFloatingStatus method executes the FloatingStatusSymb...
GETFLOATINGSTATUS
SYNTAX  Public Function UpdateClosedPosition(AccountID As Integer, TicketID As Integer, lot As Double, Price As Double, RefAskPrice As Double, Comm As Double, Interest As Double, Profit As Double, RefBidPrice As Double Optional UserDefinedDate As String ...
SYNTAX Public Function ChangePassword(ByRef OldPassword As String, ByRef NewPassword As String, ByRef ConfirmPassword As String) As CallingResultsEnum DESCRIPTION This function used to change the password for a user. After ChangePassword method execute...
SYNTAX  Public Function ManualCloseByHedge(AccountID As Integer, Ticket1 As Integer, Ticket2 As Integer, Amount As Double, RefAskPrice As Double, RefBidPrice As Double) As CallingResultsEnum  DESCRIPTION This function is used to close specific amount o...
SYNTAX  Public Function GetAccountStatement(AccountID As Integer, StatementType As StatementTypeEnum, Optional FromDate As String = "", Optional ToDate As String = "") As CallingResultsEnum  DESCRIPTION This function is used to get the statement report...
SYNTAX  Public Function GetSymbolsSettings () As CallingResultsEnum DESCRIPTION This function is used to get the settings for all symbosl which have a privilege on. After GetSymbolsSettings method executes, the SymbolsSettingsResultReceived [http://www...
SYNTAX  Public Function TransferSymbol (SymbolID As Integer, OldParentID As Integer, NewParentID As Integer) As SymbolSettingsEnum DESCRIPTION This function is used to transfer a symbol or a group of symbols form a group to another. After TransferSymbo...
SYNTAX  Public Function CreateGroupSymbol (ParentID As String, GroupName As String) As SymbolSettingsEnum DESCRIPTION This function is used to create a symbol of type group under the given parent ID. After CreateGroupSymbol method executes, the CreateS...
SYNTAX  Public Function CreateNewSymbol (ParentID As String , Name As String, Optional OpenDay As String = "Monday", Optional OpenTime As String = "00:00", Optional CloseDay As String = "Friday", Optional CloseTime As String = "23:59", Optional DailyClos...
SYNTAX Public Function RejectMultipleOrders (OrderIDs As String, Comment As String) As CallingResultsEnum DESCRIPTION This function is used to reject multiple client orders, After RejectMultipleOrders method executes, the RejectResultRecievied event fi...
SYNTAX Public Function AcceptMultipleOrders (OrderIDs As String) As CallingResultsEnum DESCRIPTION This function is used to accept multiple client orders. After AcceptMultipleOrders method executes, the AcceptResultRecievied [http://www.hybrid-solution...
SYNTAX Public Function DeleteMoneyTransaction (AccountID As Integer, TicketID As Integer) As CallingResultsEnum DESCRIPTION This function is used to delete money transaction for a specific account number. After DeleteMoneyTransaction method executes, D...
SYNTAX Public Function DeleteClosedPosition(AccountID As Integer, TicketID As Integer) As CallingResultsEnum DESCRIPTION This function is used to delete the closed position for a specific account number. After DeleteClosedPosition method executes, Dele...
SYNTAX  Public Function ManualNewLimitOrder(AccountID As Integer, OrderType As OperationTypeEnum, SymbolID As Long, Lots As Double, AtPrice As Double, Optional SL As Object = "", Optional TP As Object = "", Optional Note As String = "", Optional TransTag...
DESCRIPTION This class represents the parameter object for the client parameters settings PROPERTIES Part Description Symbol Symbol which  the parameter setting belongs to, the value of type is COSymbol [http://www.hybrid-solutions.com/sup...
SYNTAX  Public Function UpdateOpenPosition (TicketID As Integer, NewLots As Double, NewPrice As Double, NewType As OperationTypeEnum, NewInterest As Double, NewComment As String) As CallingResultsEnum DESCRIPTION This function is used to update the exi...
SYNTAX  Public Function ManualManualNewSLTPOrder (AccountID As Integer, Ticket As Integer, Lots As Double,OrderType As OperationTypeEnum ,SymbolID As Integer, Optional SL As Variant = "", Optional TP As Variant = "", Optional TransTag As String = "") As ...
SYNTAX  Public Function ManualDeleteLimitOrder (AccountID As Integer, OrderIDs As String, TransTag As String) As CallingResultsEnum DESCRIPTION This function is used to cancel an entry order without the need to select an account, after ManualDeleteLimi...
SYNTAX  Public Function GetClientParameters (ClientID As Integer) As CallingResultsEnum DESCRIPTION This function is used to get the symbol setting parameter value for the given Client ID number. After GetClientParameters method executes the ClientPara...
SYNTAX  Public Function GetGeneralClientParameters (ClientID As Integer) As CallingResultsEnum DESCRIPTION This function is used to get the general client parameter by the givnen client number, After GetGeneralClientParameters method executes the Gener...
SYNTAX  Public Function GetAccountHistroy (AccountID As Integer, Optional LastXDays As Integer = -1, Optional FromDate As String = "", Optional ToDate As String = "") As CallingResultsEnum DESCRIPTION This function is used to show the entire transactio...
SYNTAX  Event DeliveryItemDeleteFailed(ByRef SymbolID As Integer) DESCRIPTION This event fired when failed to delete delivery item by DeleteDeliveryItem [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/4735] method. PARAM...
SYNTAX  Public Function GetGroupInfo(ByRef vClient As Integer) As CallingResultsEnum DESCRIPTION This function used to get information for the given group, after GetOfficeInfo executes GroupInfoRecived [http://www.hybrid-solutions.com/support/index.php...
SYNTAX  Public Function GetOfficeInfo(ByRef vClient As Integer) As CallingResultsEnum DESCRIPTION This function used to get information for the given office, after GetOfficeInfo executes OfficeInfoRecived [http://www.hybrid-solutions.com/support/index....
SYNTAX  Public Function DeliveryItemsCount(ByRef SymID As Integer) As Integer DESCRIPTION This function is used to return the physical items count for provided symbol ID. PARAMETERS Parameter Description  SymID Trading symbol ID to get t...
SYNTAX  Public Function GetSettledStatus (Optional ClientID As Integer = 0, Optional LastXDays As Integer = -1, Optional FromDate As String = "", Optional ToDate As String = "") As CallingResultsEnum DESCRIPTION This function is used to make the API ab...
SYNTAX  Public Function GetClientInfo (vClient As Integer) As CallingResultsEnum DESCRIPTION This function is used to get information about the given client, after GetClientInfo method executes the ClientInfoRecieved [http://www.hybrid-solutions.com/su...
SYNTAX  Public Function UpdateGroup (ByRef ClientID As Integer, ByRef Name As String,ByRef Username As String ,ByRef Password As String, ByRef ReadOnly As Boolean, ByRef Phone As String, ByRef Fax As String, ByRef Mobile As String, ByRef TelFax As String...
SYNTAX  Public Function UpdateOffice (ByRef ClientID As Integer, ByRef Name As String, ByRef UserName As String, ByRef Password As String, ByRef WhiteLabeled As Boolean, ByRef Demo As Boolean, ByRef ReadOnly As Boolean, ByRef Phone As String, ByRef Fax A...
SYNTAX  Public Function UpdateClient (ClientID As Integer,FirstName As String,SecondName As String,ThirdName As String, LastName As String,UserName As String,Password As String,Tel As String,Mobile As String,TelFax As String,POB As String,Fax As String,E...
SYNTAX  Public Function UpdateAccount (ByRef AccountID As Integer, ByRef AccountType As VertexGeneral.AccountTypeEnum, ByRef OpenTime As String, ByRef IsDemo As Boolean, ByRef IsLocked As Boolean, ByRef IsLiquidated As Boolean, ByRef IsMarginAcc As Boole...
SYNTAX  Public Function Disconnect() DESCRIPTION This method use to disconnect the connection session from the server. PARAMETERS No Parameters. SAMPLE  Private Sub Disconnect_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handle...
SYNTAX  Public Function GetDeliveryItem(SymID As Integer,Index As Integer) As VertexGeneral.CDeliveryItem DESCRIPTION This function used to get the CDeliveryItem [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/4984] objec...
SYNTAX  Public Function GetChartHistory(SymbolID As Integer, Period As PeriodNoEnum, BeforeDate As Date, NumberOfBars As Integer) As CallingResultsEnum DESCRIPTION This method is used to return the open, close, high and low prices for the chart on spec...
SYNTAX  Public Function Deliver(Ticket As Integer, DeliveryItemID As String, NumberOfItems As Integer, DepID As Integer, Optional Comment As String = "") As CallingResultsEnum DESCRIPTION This function delivers the physical items for specific symbol. A...
SYNTAX  Public Function RequestDeliveryItems(Optional ByRef SymID As Integer = -1) As CallingResultsEnum DESCRIPTION This function requests physical items for specific symbol. After RequestDeliveryItems method executes the DeliveryItemsUpdated [http://...
SYNTAX  Public Function DeleteDeliveryItem(SymID As Integer,ItemID As String) As CallingResultsEnum DESCRIPTION This function deletes the physical item of a specific symbol that was added,If DeleteDeliveryItem succeeded the DeliveryItemDeleted [http://...
SYNTAX  Public Function UpdateDeliveryItem(ByRef SymID As Integer, ByRef ItemID As String, ByRef ItemImageLink As String, ByRef ItemName As String, ByRef ItemDesc As String, ByRef ItemWeight As Double, ByRef ItemEnabled As Boolean) As CallingResultsEnum ...
SYNTAX  Public Function AddDeliveryItem(ByRef SymID As Integer, ByRef ItemID As String, ByRef ItemImageLink As String,ByRef ItemName As String, ByRef ItemDesc As String, ByRef ItemWeight As String, ByRef ItemEnabled As Boolean) As CallingResultsEnum DES...
SYNTAX Public Function BroadcastMessage(ClientID As Integer,Title As String,Message As String) As CallingResultsEnum DESCRIPTION This function is used to send a message to specific client/group/office. PARAMETERS Parameter Description  Clie...
SYNTAX Function CloseByHedge(ByRef Ticket1 As Integer, ByRef Ticket2 As Integer, ByRef Amount As Double) As CallingResultsEnum DESCRIPTION This function closes specific amount of two tickets by hedge.After CloseByHedge method executes the CloseByHedgeR...
SYNTAX  Function TransferClient(ByRef ClientID As Integer, ByRef ParentID As Integer)As CallingResultsEnum DESCRIPTION This method will help you to organize the accounts tree, so you will be able to transfer a certain client/office node to another node...
SYNTAX  Function ChangeSymbolSettings(SymbolsIDs As String, Optional Name As String = “#*#”, Optional OpenDay As String = “#*#”, Optional OpenTime As String = “#*#”, Optional CloseDay As String = “#*#”, Optional CloseTime As String = “#*#”, Optional Dail...
SYNTAX  Function MaximumAmount(ByRef SymbolID As Integer) As Double DESCRIPTION This function used to returns the maximum amount per deal for specific symbol. PARAMETERS Parameter Description  SymbolID Trading symbol number that  want to...
SYNTAX  Function StopOffset(ByRef SymbolID As Integer) As Double DESCRIPTION This function use to returns value for how much the SLTP order prices should be far from the market price for specific symbol. PARAMETERS Parameter Description  Sy...
SYNTAX  Function LimitOffset(ByRef SymbolID As Integer) As Double DESCRIPTION This function use to returns value for how much the limit order prices should be far from the market price for specific symbol. PARAMETERS Parameter Description  ...
SYNTAX  Function spread(ByRef SymbolID As Integer) As Double DESCRIPTION This function use to returns the spread value for specific symbol. PARAMETERS Parameter Description  SymbolID Trading symbol number,value of type Integer. RETURN V...
SYNTAX  Function commission(ByRef SymbolID As Integer) As Double DESCRIPTION This function used to return the commission value  for specific symbol. PARAMETERS Parameter Description  SymbolID Trading symbol number ,value of type Integer....
Change time sync interval
SYNTAX  Function MinimumAmount(ByRef SymbolID As Integer) As Double DESCRIPTION This function used to returns the minimum amount per deal for specific symbol. PARAMETERS Parameter Description  SymbolID Trading symbol number that want to ...
SYNTAX  Function DisconnectSession(ByRef Session As COnlineSession)As CallingResultsEnum  DESCRIPTION To disconnect a specific client.After DisconnectSession method executes the SessionDisconnected [http://www.hybrid-solutions.com/support/index.php?/Kn...
SYNTAX  Public Function ChangeParam(ClientID As Integer, ParamType As ParamTypeEnum, InheritValue As Boolean, newValue As String, Optional SymbolIDs As String = "-1") As CallingResultsEnum DESCRIPTION This function used to change a parameter value acco...
SYNTAX  Function CreateOffice(ParentUsername As String,Name As String,Username As String,Password As String ,ShowAsDemo As Boolean,ReadOnlyLogin As Boolean,Phone As String,Fax As String,Mobile As String,TelPWD As String,POB As String,Email As String,Addr...
SYNTAX  Function CreateGroup(ParentUsername As String,Name As String,Username As String,Password As String, ReadOnlyLogin As Boolean,Phone As String,Fax As String,Mobile As String,TelPWD As String,POB As String,Email As String,Address As String,ChangePW ...
SYNTAX  Public Function UpdateSLTPOrder(OrderID As Long, Lots As Double, Optional SL As Object = "", Optional TP As Object = "", Optional TransTag As String = "") As CallingResultsEnum DESCRIPTION This function is used to update SL/TP order. A user acc...
SYNTAX  Public Function UpdateLimitOrder(OrderID As Integer , Lots As Double, NewPrice As Double, Optional SL As Object = "", Optional TP As Object = "", Optional Note As String = "", Optional TransTag As String = "") As CallingResultsEnum DESCRIPTION ...
SYNTAX  Function SwitchOrder(ByRef OrderID As Integer) As CallingResultsEnum DESCRIPTION This function is used to pass order to another available dealer. PARAMETERS Part Description  OrderID Associated order number that want to switch,v...
SYNTAX  Public Function NewSLTPOrder(Ticket As Integer, Lots As Double, Optional SL As Variant = "", Optional TP As Variant = "", Optional TransTag As String = "") As CallingResultsEnum DESCRIPTION This function is used to create a new SL/TP order for ...
SYNTAX  Public Function NewLimitOrder(OrderType As OperationTypeEnum, SymbolID As Integer, Lots As Double, AtPrice As Double, Optional SL As Object = "", Optional TP As Object = "", Optional Note As String = "", Optional TransTag As String = "") As Calli...
SYNTAX Function DeleteSLTPOrder(ByRef OrderIDs As String,ByRef TransTag As String)As CallingResultsEnum DESCRIPTION This function used to delete SL/TP order.A user account must be selected [http://www.hybrid-solutions.com/support/index.php?/Knowledgeba...
Syntax  Function DeleteLimitOrder(ByRef OrderIDs As String,ByRef TransTag As String)As CallingResultsEnum DESCRIPTION This function used to delete a limit order. A user account must be selected [http://www.hybrid-solutions.com/support/index.php?/Knowle...
SYNTAX  Function ClientSymbol(ByRef SymbolID As Integer, ByRef AccountID As Integer) As COSymbol DESCRIPTION This function used to return COSymbol [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/2147] object to get symbol...
SYNTAX  Public Function CreateAccount(Username As String, AccountID As Integer, AccountType As AccountTypeEnum, Time As String, DemoAccount As Boolean, LockedAccount As Boolean, DontLiquidate As Boolean, MarginAccount As Boolean, TransTag As String,Optio...
SYNTAX Function CreateClient(ParentUsername As String,FirstName As String,SecondName As String,ThirdName As String, LastName As String,Username As String,Password As String,Phone As String,Fax As String, Mobile As String, TelPW As String ,POB As String,C...
SYNTAX  Function SendSMSToSelcectedAccount(ByRef SMSText As String) As CallingResultsEnum DESCRIPTION To send SMS to an already selected account through selectAccount [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/2065]....
SYNTAX Function SendSMS(ByRef AccountID As Integer,ByRef SMSText As String) As CallingResultsEnum DESCRIPTION To send SMS to a specific client .After SendSMS method executes SendSMSResultReceived [http://www.hybrid-solutions.com/support/index.php?/Know...
SYNTAX  Function AccountSummaries(ByVal AccountID As Integer, ByRef Balance As Double, ByRef FltPL As Double, ByRef Credit As Double, ByRef Equity As Double,ByRef MarginReq As Double,ByRef MaginLevel As Double, ByRef EffMargin As Double) As VertexFXBOAPI...
SYNTAX Function SwitchChat(ByRef ChatOn As Boolean) As VertexFXBOAPI.CallingResultsEnum DESCRIPTION This function used to turn chatting screen on or off.After SwitchChat method executes the ChatStatus [http://www.hybrid-solutions.com/support/index.php?...
SYNTAX  Function ClosePosition(ByRef AccountID As Integer, ByRef Ticket As Integer, ByRef Amount As Double, ByRef Price As Double, ByRef RefAskPrice As Double, ByRef Comm As Double, RefBidPrice As Double,TransTag As String ,Optional UserDefinedDate As St...
Syntax  Public Function NewPosition(AccountIDs As String, BuySells As String, Amounts As String, SymbolIDs As String, PriceS As String, Optional Notes As String = "", Optional TransTag As String = "",Optional UserDefinedDate As String = "") As CallingRes...
SYNTAX  Function RejectOrder(ByRef vOrderID As Integer,ByRef Comment As String)As CallingResultsEnum DESCRIPTION This function used to reject client order by giving the order number.After RejectOrder method executes the RejectResultRecieved [http://www...
SYNTAX   Function AcceptOrder(ByRef vOrderID As Integer,Optional ByRef AcceptPrice As Double = 0.0) As   VertexFXBOAPI.CallingResultsEnum DESCRIPTION This function used to accept client order by giving the order number.After AcceptOrder method executes...
SYNTAX  Function SelectAccount(ByRef AccountID As Integer) As CallingResultsEnum DESCRIPTION To choose which account that want to load its pending orders and open positions . Note that an account must be selected before performing any operation such as...
Help Desk Software by Hybrid Solutions