| PUT | /order_book/edit |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderBook | body | OrderBook | No | |
| PartnerIds | body | List<int> | No | |
| Partners | body | Partners | 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| 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 .jsv suffix or ?format=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.fxhub.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
}