| GET | /order_book/{Id} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | OrderBook | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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}}