GET api/orders/nettingorder/{nettingOrderID}
Get netting order with netting order ID
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| nettingOrderID |
Netting Order Entity ID |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
NettingOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientID |
Client ID of client account |
integer |
Required |
| ClientName |
Client account name. If not supplied, ClientName is generated from account holder information |
string |
Required |
| ClientRef |
External reference. An identifer of account in front office systems. Orders entered via the BOON+ interface must use matching value to populate BOON+.ClientOrderNumber field |
string |
None. |
| Quantity |
Order quantity. |
integer |
Required |
| QuantityBooked |
Quantity booked to the order. |
integer |
Required |
| VWAP |
Volume Weighted Average Price of trades currently booked (Note: may be blank/omitted). |
decimal number |
None. |
Response Formats
application/json, text/json
{
"ClientID": 100500,
"ClientName": "John Smith",
"ClientRef": "BP101",
"Quantity": 1000,
"QuantityBooked": 0,
"VWAP": 0.0
}
application/xml, text/xml
<NettingOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Order"> <ClientID>100500</ClientID> <ClientName>John Smith</ClientName> <ClientRef>BP101</ClientRef> <Quantity>1000</Quantity> <QuantityBooked>0</QuantityBooked> <VWAP>0</VWAP> </NettingOrder>
Error Response Information
Resource Description
stringError Response Formats
application/json, text/json
"sample string 1"
application/xml, text/xml
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>