FxHubPartnersApi

EditOrderBook

The following routes are available for this service:
PUT	/order_book/edit

**EditOrderBook** Parameters:
Name	Parameter	Data Type	Required
OrderBook	body	OrderBook	No
PartnerIds	body	List<int>	No
Partners	body	Partners	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

**Partners** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
PartnerName	form	string	No
RegNo	form	string	No
FspNo	form	string	No
LandobyteName	form	string	No
ShortName	form	string	No
IsSubAdvisor	form	string	No
ParentPartner	form	string	No
Address	form	string	No
Suburb	form	string	No
City	form	string	No
Province	form	string	No
PostalCode	form	string	No
PartnerContactNumber	form	string	No
WebsiteUrl	form	string	No
MainContact	form	string	No
ContactEmail	form	string	No
ContactMobile	form	string	No
PartnerLogoUrl	form	string	No

**EditOrderBookResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	bool	No
Message	form	string	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.

PUT /order_book/edit HTTP/1.1 
Host: api.fxlink.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EditOrderBook xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel">
  <OrderBook 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>
  </OrderBook>
  <PartnerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </PartnerIds>
  <Partners xmlns:d2p1="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel.Types">
    <d2p1:Address>String</d2p1:Address>
    <d2p1:City>String</d2p1:City>
    <d2p1:ContactEmail>String</d2p1:ContactEmail>
    <d2p1:ContactMobile>String</d2p1:ContactMobile>
    <d2p1:FspNo>String</d2p1:FspNo>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:IsSubAdvisor>String</d2p1:IsSubAdvisor>
    <d2p1:LandobyteName>String</d2p1:LandobyteName>
    <d2p1:MainContact>String</d2p1:MainContact>
    <d2p1:ParentPartner>String</d2p1:ParentPartner>
    <d2p1:PartnerContactNumber>String</d2p1:PartnerContactNumber>
    <d2p1:PartnerLogoUrl>String</d2p1:PartnerLogoUrl>
    <d2p1:PartnerName>String</d2p1:PartnerName>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:Province>String</d2p1:Province>
    <d2p1:RegNo>String</d2p1:RegNo>
    <d2p1:ShortName>String</d2p1:ShortName>
    <d2p1:Suburb>String</d2p1:Suburb>
    <d2p1:WebsiteUrl>String</d2p1:WebsiteUrl>
  </Partners>
</EditOrderBook>

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

<EditOrderBookResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel">
  <Message>String</Message>
  <Result>false</Result>
</EditOrderBookResponse>