FxHubPartnersApi

<back to all web services

GetAllTradeQuotes

Requires Authentication
The following routes are available for this service:
GET/trade_quotes/all
GetAllTradeQuotesResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<TradeQuotes>No
MessageformstringNo
TradeQuotes Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PartnerIdformintNo
PartnerNameformstringNo
UserIdformintNo
UserNameformstringNo
AdminIdformintNo
AdminNameformstringNo
ClientIdformintNo
FirstLastNameformstringNo
SelectedRateformstringNo
TradeTypeformstringNo
EnteredZarformboolNo
CrossCurrencyformstringNo
TradeCurrencyformstringNo
TradeTimingformstringNo
CommissionRateformdecimal?No
CommissionRateInclVatformdecimal?No
BuyZarTradeZarValueformdecimal?No
BuyZarTradeCrossValueformdecimal?No
SellZarTradeZarValueformdecimal?No
SellZarTradeCrossValueformdecimal?No
CrossTradeValueformdecimal?No
CrossTradeCrossValueformdecimal?No
TradeValueformdecimal?No
CrossValueformdecimal?No
QuotedRateformdecimal?No
ClientRateformdecimal?No
InitialSendformDateTime?No
InitialSendTimeformstringNo
InitialReplyTimeformstringNo
QuoteStatusformstringNo
QuoteAcceptedformbool?No
QuoteAcceptedDateformDateTime?No
QuoteAcceptedTimeformstringNo
QuoteDeclinedDateformDateTime?No
QuoteDeclinedTimeformstringNo
AcHasRepliedformbool?No
ZarAccountNumberformstringNo
FcaAccountNumber1formstringNo
FcaAccountNumber2formstringNo
TradeAccountNumberformstringNo
FcaCurrency1formstringNo
FcaCurrency2formstringNo
HasClientTccformbool?No
TccApplicationStatusformstringNo
SdaRemainderformdecimal?No
TccRemainderformdecimal?No
CurrentZarCashBalanceformdecimal?No
CurrentFca1CashBalanceformdecimal?No
CurrentFca2CashBalanceformdecimal?No
CurrentTradeCashBalanceformdecimal?No
HasChatEnabledformbool?No
DoesHaveChatformstringNo
HasSufficientCashBalanceformstringNo
HasSufficientSdaBalanceformstringNo
HasSufficientTccBalanceformstringNo
RiskStatusformstringNo
ActualTradedRateformdecimal?No
TradeQuoteMessagesformList<TradeQuoteMessage>No
TradeQuoteMessage Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
SentByformstringNo
UpdatedAtformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /trade_quotes/all HTTP/1.1 
Host: api.fxhub.co.za 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	[
		{
			id: 0,
			partnerId: 0,
			partnerName: String,
			userId: 0,
			userName: String,
			adminId: 0,
			adminName: String,
			clientId: 0,
			firstLastName: String,
			selectedRate: String,
			tradeType: String,
			enteredZar: False,
			crossCurrency: String,
			tradeCurrency: String,
			tradeTiming: String,
			commissionRate: 0,
			commissionRateInclVat: 0,
			buyZarTradeZarValue: 0,
			buyZarTradeCrossValue: 0,
			sellZarTradeZarValue: 0,
			sellZarTradeCrossValue: 0,
			crossTradeValue: 0,
			crossTradeCrossValue: 0,
			tradeValue: 0,
			crossValue: 0,
			quotedRate: 0,
			clientRate: 0,
			initialSend: 0001-01-01,
			initialSendTime: String,
			initialReplyTime: String,
			quoteStatus: String,
			quoteAccepted: False,
			quoteAcceptedDate: 0001-01-01,
			quoteAcceptedTime: String,
			quoteDeclinedDate: 0001-01-01,
			quoteDeclinedTime: String,
			acHasReplied: False,
			zarAccountNumber: String,
			fcaAccountNumber1: String,
			fcaAccountNumber2: String,
			tradeAccountNumber: String,
			fcaCurrency1: String,
			fcaCurrency2: String,
			hasClientTcc: False,
			tccApplicationStatus: String,
			sdaRemainder: 0,
			tccRemainder: 0,
			currentZarCashBalance: 0,
			currentFca1CashBalance: 0,
			currentFca2CashBalance: 0,
			currentTradeCashBalance: 0,
			hasChatEnabled: False,
			doesHaveChat: String,
			hasSufficientCashBalance: String,
			hasSufficientSdaBalance: String,
			hasSufficientTccBalance: String,
			riskStatus: String,
			actualTradedRate: 0,
			tradeQuoteMessages: 
			[
				{
					message: String,
					sentBy: String,
					updatedAt: String
				}
			]
		}
	],
	message: String
}