FxHubPartnersApi

<back to all web services

EditOrderBook

Requires Authentication
The following routes are available for this service:
PUT/order_book/edit
EditOrderBook Parameters:
NameParameterData TypeRequiredDescription
OrderBookbodyOrderBookNo
PartnerIdsbodyList<int>No
PartnersbodyPartnersNo
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
Partners Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PartnerNameformstringNo
RegNoformstringNo
FspNoformstringNo
LandobyteNameformstringNo
ShortNameformstringNo
IsSubAdvisorformstringNo
ParentPartnerformstringNo
AddressformstringNo
SuburbformstringNo
CityformstringNo
ProvinceformstringNo
PostalCodeformstringNo
PartnerContactNumberformstringNo
WebsiteUrlformstringNo
MainContactformstringNo
ContactEmailformstringNo
ContactMobileformstringNo
PartnerLogoUrlformstringNo
EditOrderBookResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
MessageformstringNo

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.

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

{
	orderBook: 
	{
		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
	},
	partnerIds: 
	[
		0
	],
	partners: 
	{
		id: 0,
		partnerName: String,
		regNo: String,
		fspNo: String,
		landobyteName: String,
		shortName: String,
		isSubAdvisor: String,
		parentPartner: String,
		address: String,
		suburb: String,
		city: String,
		province: String,
		postalCode: String,
		partnerContactNumber: String,
		websiteUrl: String,
		mainContact: String,
		contactEmail: String,
		contactMobile: String,
		partnerLogoUrl: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: False,
	message: String
}