FxHubPartnersApi

GetOrderBook

The following routes are available for this service:
GET	/order_book/{Id}

**GetOrderBook** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	int	No

**GetOrderBookResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	OrderBook	No

**OrderBook** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
ClientId	form	int	No
ClientName	form	string	No
PartnerId	form	int	No
PartnerName	form	string	No
DatePlaced	form	DateTime?	No
TimePlaced	form	string	No
ExpiryDate	form	DateTime?	No
ExpiryTime	form	string	No
EditTime	form	string	No
CurrencyType	form	string	No
TradeLevel	form	decimal?	No
ClientLevel	form	decimal?	No
CurrencyAmount	form	decimal?	No
ZarNominal	form	decimal?	No
TraderName	form	string	No
OrderComments	form	string	No
OrderType	form	string	No
OrderStatus	form	string	No
HasExpiry	form	bool?	No
IsCorporateOrder	form	bool?	No

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

HTTP + XML

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

GET /order_book/{Id} HTTP/1.1 
Host: api.fxlink.co.za 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetOrderBookResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel">
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel.Types">
    <d2p1:ClientId>0</d2p1:ClientId>
    <d2p1:ClientLevel>0</d2p1:ClientLevel>
    <d2p1:ClientName>String</d2p1:ClientName>
    <d2p1:CurrencyAmount>0</d2p1:CurrencyAmount>
    <d2p1:CurrencyType>String</d2p1:CurrencyType>
    <d2p1:DatePlaced>0001-01-01T00:00:00</d2p1:DatePlaced>
    <d2p1:EditTime>String</d2p1:EditTime>
    <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
    <d2p1:ExpiryTime>String</d2p1:ExpiryTime>
    <d2p1:HasExpiry>false</d2p1:HasExpiry>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:IsCorporateOrder>false</d2p1:IsCorporateOrder>
    <d2p1:OrderComments>String</d2p1:OrderComments>
    <d2p1:OrderStatus>String</d2p1:OrderStatus>
    <d2p1:OrderType>String</d2p1:OrderType>
    <d2p1:PartnerId>0</d2p1:PartnerId>
    <d2p1:PartnerName>String</d2p1:PartnerName>
    <d2p1:TimePlaced>String</d2p1:TimePlaced>
    <d2p1:TradeLevel>0</d2p1:TradeLevel>
    <d2p1:TraderName>String</d2p1:TraderName>
    <d2p1:ZarNominal>0</d2p1:ZarNominal>
  </Result>
</GetOrderBookResponse>