Knowledgebase : Technical Support > API > BackEnd API's/VBL > VertexFX Backoffice WCF Service (Primitive) > VertexFX Backoffice WCF Service
SYNTAX  Function DisconnectSession(SessionName As String, SessionType As Integer) DESCRIPTION The DisconnectSession operation is used to disconnect the connected session by its name and Type. REQUEST PARAMETERS Name Description  Required ...
SYNTAX  Function GetOnlineSessions() As String DESCRIPTION The GetOnlineSessions operation is used to retrieve the all the online sessions that the logged in dealer has privilege on    RESPONSE ELEMENTS Name Description  Result This operat...
PARAMTYPEENUM Name Code Description SpreadType 1 Fixed: The new value must be as the Following FIX@@Value@@the differences between ask and bid  Source Plus: The new value must be as the Following S@@Value@@the differences between as...
SYNTAX Public Function ChangeClientParam(ClientID As Integer, ParamType As Integer, InheritValue As Boolean, NewValue As String, Optional ByVal SymbolIDs As String = "-1") As String DESCRIPTION This function is used to change the Symbols and the genera...
Syntax Public Function GetGeneralClientParam(ClientID As Integer) As String DESCRIPTION This function is used to get the general parameter for the given client ID which the logged in dealer has privilege on. PARAMETERS Name Description  Requ...
SYNTAX Public Function GetClientParam(ClientID As Integer) As String DESCRIPTION This function is used to get the parameter for the given client ID which the logged in dealer has privilege on. PARAMETERS Name Description  Required Client...
 SYNTAX  Public Function GetClient() As String DESCRIPTION The GetClient operation is used to return the client information which is under the logged in dealer.  REQUEST PARAMETERS   No request parameters. RESPONSE ELEMENTS Name Descrip...
 SYNTAX Public Function GetAccounts() As String DESCRIPTION The GetAccounts operation is used to return the accounts information which is under the logged in dealer. REQUEST PARAMETERS   No request parameters. RESPONSE ELEMENTS Name De...
 SYNTAX  ChangePassword(OldPW As String, NewPW As String, ConfirmNewPW As String) As String DESCRIPTION The ChangePassword operation is used to change the logged in Dealer password with new one.  REQUEST PARAMETERS Name Description  Required...
 SYNTAX  Public Function RequoteOrder (OrderID As Long, ReqPrice As Double) As String DESCRIPTION The RequoteOrder operation is used to requote the given OrderID at specific price.  REQUEST PARAMETERS Name Description  Required OrderID ...
 SYNTAX  Public Function RejectOrder (OrderID As Long, Optional ByVal Comment As String = "")  As String DESCRIPTION The RejectOrder operation is used to reject the given OrderID  which belongs to the client under the logged in dealer Id.  REQUEST PAR...
 SYNTAX  Public Function AcceptOrder (OrderID As Long) As String DESCRIPTION The AcceptOrder operation is used to accept the given OrderID on the request order price.  REQUEST PARAMETERS Name Description  Required OrderID * Order numb...
 SYNTAX  Public Function GetChatOrder() As String DESCRIPTION The GetChatOrder operation is used get the new chat orders that received to the logged in dealer web session .  REQUEST PARAMETERS No requested parameter  Response Elements Name De...
 SYNTAX  Public Function ManualDeleteLimit (AccountID As Long, OrderID As Long) As String DESCRIPTION The ManualDeleteLimit operation is used to cancel the given entry order that belongs to the given account number.  REQUEST PARAMETERS Name Des...
 SYNTAX  Public Function ClosePosition(AccountID As Long, TicketID As Integer, Amount As Double, Price As Double, RefPrice As Double, Comm As Double, Optional UserDefinedDate As String = "")  As String DESCRIPTION The ClosePosition operation is used to...
 SYNTAX  Public Function ManualUpdateLimit (AccountID As Long, OrderID As Long, Lot As Double, Price As Double, Optional SL As String = "", Optional TP As String = "", Optional Note As String = "") As String DESCRIPTION The ManualUpdateLimit operation ...
 SYNTAX  Public Function UpdatePosition (AccountID As Long, TicketID As Integer, Lot As Double, Price As Double, BuySell As Integer, Interest As Double, Optional Note As String = "", Optional UserDefinedDate As String = "")  As String DESCRIPTION The U...
 SYNTAX  Public Function ManualNewLimit (AccountID As Long, LimitType As Integer, SymbolID As Integer, Lot As Double, AtPrice As Double, Optional SL As String = "", Optional TP As String = "", Optional Note As String = "") As String DESCRIPTION The Man...
 SYNTAX  Public Function NewPosition (AccountID As Long, BuySell As Integer, Amount As Double, SymbolID As Integer, Price As Double, Optional Note As String = "", Optional UserDefinedDate As String = "") As String DESCRIPTION The NewPosition operation ...
 SYNTAX  Public Function BroadcastMessage (ClientID As Long, Title As String, Message As String) As String DESCRIPTION The BroadcastMessage operation is used to send specific message to the given client/Group/Office ID.  REQUEST PARAMETERS Name ...
 SYNTAX  Public Function SymbolLotsReport(ClientID As Long, FromDate As String, ToDate As String,  Optional ByVal isPaging As Boolean = False) As String DESCRIPTION The SymbolLotsReport operation is used to get the symbol lots report that shows the net...
REFLECTION FLAG  Name Code SettledStatusRef 1 FloatingStatusRef 2 TransactionsLogRef 3 ChatOrder 4 SessionsChanged 5   ------------------------- SEE ALSO * BackofficeLogin [http://www.hybrid-solutions.com/suppo...
 SYNTAX  Public Function LoginHistoryReport(ClientID As Long, FromDate As String, ToDate As String, IP As String, API As Integer, Username As String, Status As Integer, WhoType As Integer, WhoID As Integer, Optional ByVal isPaging As Boolean = False) As ...
 SYNTAX  Public Function MarketOrdersHistoryReport(ClientID As Long, FromDate As String, ToDate As String, OrderID As Integer, TicketID As Integer, AccountID As Long, TransType As String, OrderType As Integer, Amount As Double, SymbolID As Integer, Price...
 SYNTAX  Public Function PendingOrdersReport (ClientID As Long, FromDate As String, ToDate As String, AccountID As Integer, OrderType As Integer, Lots As Double, SymbolID As Integer, Price As Double,Optional ByVal isPaging As Boolean = False) As String ...
 SYNTAX  Public Function DetailedOpenPositionsReport(ClientID As Long, AccountType As Integer, SymbolID As Integer, PositionType As Integer, Optional ByVal isPaging As Boolean = False) As String DESCRIPTION The DetailedOpenPositionsReport operation is ...
SYNTAX  Public Function NetOpenPositionsReport(ClientID As Long, AccountType As Integer, SymbolID As Integer, PositionType As Integer, Optional ByVal isPaging As Boolean = False) As String DESCRIPTION The NetOpenPositionsReport operation is used to get...
 SYNTAX  Public Function MaintenanceMarginCallReport(ClientID As Long, Optional ByVal isPaging As Boolean = False) As String DESCRIPTION The MaintenanceMarginCallReport operation is used to get maintenance margin call report that shows the account(s) w...
 SYNTAX  Public Function AccountInfoReport (ClientID As Long, Optional ByVal isPaging As Boolean = False) As String DESCRIPTION The AccountInfoReport operation is used to get the account information report that shows the information for all accounts un...
 SYNTAX  Public Function AccountStatusReport (ClientID As Long, AccountType As Integer, Optional ByVal isPaging As Boolean = False) As String DESCRIPTION The AccountStatusReport operation is used to get account status report for all accounts under the ...
SYNTAX  Public Function MoneyTransReport (ClientID As Long, TransType As Integer, FromDate As String, ToDate As String, Optional ByVal isPaging As Boolean = False) As String DESCRIPTION The MoneyTransReport operation is used to get the money transactio...
 SYNTAX  Public Function SMSReport(ClientID As Long, FromDate As String, ToDate As String,  Optional ByVal isPaging As Boolean = False) As String DESCRIPTION The SMSReport operation is used to get the SMS report that shows you the details of each SMS s...
SYNTAX  Public Function SymbolTypesReport(ClientID As Long, FromDate As String, ToDate As String,  Optional ByVal isPaging As Boolean = False) As String DESCRIPTION The SymbolTypesReport opertation is used to get the symbol type report that shows the n...
 SYNTAX  Function TransactionLogReport(ClientID As Long, FromDate As String, ToDate As String, TicketOrder As Long, Trans As Long, TransType As Long, Account As Long, BuySell As Integer, LotsAmount As Double, SymbolID As Long, Price As Double, ClosePrice...
SYNTAX Public Function GetDealerReflection() As String DESCRIPTION The GetDealerReflection operation is used to retrieve all updates flag on clients that related to the logged in dealer to make all client data current and up to date. REQUEST PARAMETER...
 SYNTAX Function GetDealerSymbol(Optional ByVal SymbolID As Integer = 0) As String DESCRIPTION The GetDealerSymbol operation is used to get list of Symbol/s information for the given symbol Id or for all symbol that the login dealer has privilege on. ...
SYNTAX  Public Function GetClientsInfo(ClientID As Long) As String DESCRIPTION The GetClientsInfo operation is used to get a list of client information for all client that related to the given parent identifier. REQUEST PARAMETERS Name Descript...
 SYNTAX  Function GetClientsUsernames (ClientID  As String) As String DESCRIPTION The GetClientsUsernames operation is used to get the list of usernames which are related to the given parent identifier  . REQUEST PARAMETERS Name Description  ...
 SYNTAX  Function GetClientByUsername (Username As String) As String DESCRIPTION The GetClientByUsername operation is used to get the given username information . REQUEST PARAMETERS Name Description  Required  Username * Client userna...
 SYNTAX  Function GetFloatingStatus (ClientID As Long, Optional ByVal SymbolID As Integer = 0) As String DESCRIPTION The GetFloatingStatus operation is used to get the floating Status report for a specific given client number. REQUEST PARAMETERS N...
 SYNTAX  Function GetSettledStatus(ClientID As Long, FromDate As String, ToDate As String, Optional ByVal LastXDays As Integer = 0, Optional ByVal SymbolID As Integer = 0) As String DESCRIPTION The GetSettledStatus operation is used to get the settled ...
 SYNTAX  Public Function UpdateAccount(ClientID As Integer, AccountId As Long, Islocked As Boolean, DoNotLiquidate As Boolean, isDemo As Boolean, AccountType As String, ismargin  As String, DefinedDate As String)  As String DESCRIPTION The UpdateAccoun...
 SYNTAX  Function UpdateGroupInfo(ClientID As Integer, GroupDescription As String, GroupUsername As String, Password As String, Read_Only As String, Phone As String, Fax As String, Mobile As String, TelPWD As String, POB As String, Email As String, Addre...
 SYNTAX  Public Function UpdateOfficeInfo(ClientID As Integer, OfficeName As String, UsernameAs String, Password As String, Phone As String, Fax As String, Mobile As String, TelPWD As String, POB As String, Email As String, Address As String, isDemo As B...
 SYNTAX  Function UpdateClientInfo(ClientID As Integer, 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 ...
 SYNTAX  Function CreateGroup(ParentID As Integer, 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, Ch...
 SYNTAX  Function CreateOffice(ParentID As Integer, Name As String, Username As String, Password As String, IsDemo As Boolean, ReadOnly As Boolean, Phone As String, Fax As String, Mobile As String, TelFax As String, POB As String, Email As String, Addres...
 SYNTAX  Function GetAccountByID (AccountId As long) As String DESCRIPTION The GetAccountByID operation is used to get information about the given account number.Use GetAccountsIDs [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Artic...
 SYNTAX Function GetClientByID (ClientID As long) As String DESCRIPTION The GetClientByID operation is used to get client information for a given client number. REQUEST PARAMETERS Name Description  Required   ClientID * Client number to...
SYNTAX  Public Function GetAccountsIDs(ClientID As String) As String DESCRIPTION The GetAccountsIDs operation is used to get the list of account/s Id/s  which are related to a given client number.   REQUEST PARAMETERS Name Description  Requ...
 SYNTAX  Function GetClientsIDs (ParentID As Integer) As String DESCRIPTION The GetClientsIDs operation is used to get the list of ID’s which are related to a given parent Identifier.   REQUEST PARAMETERS Name Description  Required   Pare...
ACCOUNTTYPE Numeric code Value NormalAccountType 1 Create end user trader account CoverageAccountType 2 Create account for bridge issue ------------------------- SEE ALSO * Reflection Flag [http://www.hybrid-solutions.com/sup...
TRANSTYPE Numeric code Value 1 Deposit -1 Withdrawal 2 Adjustment 3 Credit In -3 Credit Out ------------------------- SEE ALSO * AccountType [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Arti...
SYNTAX  CreateAccount(ParentID As Integer, AccountID As Long, AccountType As Integer, IsDemo As Boolean, IsLocked As Boolean, DontLiquidate As Boolean, IsMargin As Boolean, UserDefinedDate As String) As String DESCRIPTION The CreateAccount operation is...
SYNTAX   MoneyTrans(AccountID As Long, TransType As Integer, Amount As Double, Description As String, UserDefinedDate As String) As String DESCRIPTION The MoneyTrans operation is used to make any money transaction (Deposit , Withdrawal , Adjustment, Cr...
SYNTAX   Function CreateClient(ParentID As Integer, 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 Stri...
Common Errors and Constants Name Code Description TradingIsClosedError -5 Trading session is closed OrderAlreadyProcessed -6 Request order is already processed NotEnoughMoneyError -234 Not enough money to make a pos...
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. ----------...
SYNTAX Function GetTransactions (AfterID As Long) DESCRIPTION The GetTransactions operation is used to return the transactions log after the specific transaction log ID. before calling this operation you have to call GetAccountTransaction [http://www....
SYNTAX  BackofficeLogin (username As String, password As String) DESCRIPTION The Login operation should be called before any other operation since any requested operation has to be authenticated. REQUEST PARAMETERS Name Description  Required...
Help Desk Software by Hybrid Solutions