FxHubPartnersApi

<back to all web services

GetOrderBookList

Requires Authentication
The following routes are available for this service:
GET/order_book
GetOrderBookList Parameters:
NameParameterData TypeRequiredDescription
IdqueryintNo
ClientIdqueryintNo
GetOrderBookListResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<OrderBook>No
MessageformstringNo
OrderBook Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ClientIdformintNo
ClientNameformstringNo
PartnerIdformintNo
PartnerNameformstringNo
DatePlacedformDateTime?No
TimePlacedformstringNo
ExpiryDateformDateTime?No
ExpiryTimeformstringNo
EditTimeformstringNo
CurrencyTypeformstringNo
TradeLevelformdecimal?No
ClientLevelformdecimal?No
CurrencyAmountformdecimal?No
ZarNominalformdecimal?No
TraderNameformstringNo
OrderCommentsformstringNo
OrderTypeformstringNo
OrderStatusformstringNo
HasExpiryformbool?No
IsCorporateOrderformbool?No

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 /order_book 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,
			clientId: 0,
			clientName: String,
			partnerId: 0,
			partnerName: String,
			datePlaced: 0001-01-01,
			timePlaced: String,
			expiryDate: 0001-01-01,
			expiryTime: String,
			editTime: String,
			currencyType: String,
			tradeLevel: 0,
			clientLevel: 0,
			currencyAmount: 0,
			zarNominal: 0,
			traderName: String,
			orderComments: String,
			orderType: String,
			orderStatus: String,
			hasExpiry: False,
			isCorporateOrder: False
		}
	],
	message: String
}