curl --request GET \
--url https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"$type": "Derivitec.Web.Core.TradeBooking.ApiGetContractSchemaResponse, Derivitec.Web.Core",
"is_success": true,
"error_messages": [
"<string>"
],
"contract_schema": {
"$type": "Derivitec.Web.Core.TradeBooking.ContractSchema, Derivitec.Web.Core",
"contract_name": "<string>",
"contract_description": "<string>",
"manual_page": "<string>",
"controls": [
{
"$type": "Derivitec.Web.Core.TradeBooking.VueControl, Derivitec.Web.Core",
"property_name": "<string>",
"property_options": [
{
"$type": "Derivitec.Web.Core.TradeBooking.VueOption, Derivitec.Web.Core",
"title": "Physical",
"value": "Physical"
}
],
"display_name": "<string>",
"activation_label": "Lower Knockout Active",
"inactive_value": -1,
"input_group": "<string>",
"component": "text_box",
"column_span": 123,
"dictionary_value_vue_controls": "<array>",
"is_multiple_input": true,
"visible_when_property_name": "<string>",
"visible_when_values": [
"<string>"
],
"visible_when_operator": "matches_any",
"currency_pair_property_name": "fx_pair"
}
],
"default_position": {
"$type": "Derivitec.Web.Core.Positions.Position, Derivitec.Web.Core",
"book": "<string>",
"contract_size": 123,
"quantity": 123,
"quantity_traded": 123,
"quantity_currency": "<string>",
"buy_sell": "<string>",
"tradable_id": "<string>",
"trade_action": "<string>",
"client_transaction_id": "<string>",
"counterparty": "<string>",
"structure": "<string>",
"leg": "<string>",
"stamp_derivitec_id": true,
"traded_price_today": 123,
"traded_price_previous": 123,
"dealing_bank": "<string>",
"notes": "<string>",
"trade_date": "2023-11-07T05:31:56Z",
"traded_notional": 123,
"team": "<string>",
"split_by_reporting_currency": true,
"dealer_name": "<string>",
"counterparty_alias": "<string>",
"client": "<string>",
"reference": "<string>",
"product_type": "<string>",
"business_unit": "<string>",
"sub_business_unit": "<string>",
"counterparty_account": "<string>",
"strategy": "<string>",
"entity": "<string>",
"client_tradable_id": "<string>",
"string_label1": "<string>",
"string_label2": "<string>",
"string_label3": "<string>",
"string_label4": "<string>",
"string_label5": "<string>",
"string_label6": "<string>",
"string_label7": "<string>",
"string_label8": "<string>",
"string_label9": "<string>",
"string_label10": "<string>",
"string_label11": "<string>",
"string_label12": "<string>",
"string_label13": "<string>",
"string_label14": "<string>",
"string_label15": "<string>",
"string_label16": "<string>",
"string_label17": "<string>",
"string_label18": "<string>",
"string_label19": "<string>",
"string_label20": "<string>",
"string_label21": "<string>",
"string_label22": "<string>",
"string_label23": "<string>",
"string_label24": "<string>",
"string_label25": "<string>",
"string_label26": "<string>",
"string_label27": "<string>",
"string_label28": "<string>",
"string_label29": "<string>",
"string_label30": "<string>",
"decimal_label1": 123,
"decimal_label2": 123,
"decimal_label3": 123,
"decimal_label4": 123,
"decimal_label5": 123,
"decimal_label6": 123,
"decimal_label7": 123,
"decimal_label8": 123,
"decimal_label9": 123,
"decimal_label10": 123,
"date_label1": "2023-11-07T05:31:56Z",
"date_label2": "2023-11-07T05:31:56Z",
"contract": {
"$type": "Derivitec.Web.Core.Tradables.Ascot, Derivitec.Web.Core",
"identifier": "<string>",
"currency": "<string>",
"expiration_date": "2023-11-07T05:31:56Z",
"asset_swap_spread": 123,
"bond_identifier": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"identifier_type": "Derivitec",
"market_identification_code": "<string>"
},
"business_day_convention": "actual",
"calendar_name": "<string>",
"coupon_rate": 123,
"day_count_convention": "actual_actual_icma",
"end_stub": "none",
"end_to_end": true,
"notional": 123,
"payment_lag": 123,
"period_str": "<string>",
"rate_asset_name": "<string>",
"roll_date": "2023-11-07T05:31:56Z",
"start_date": "2023-11-07T05:31:56Z",
"start_stub": "none",
"initial_fx_rate": 123
}
},
"client_security_id": "<string>"
}
}Retrieve the booking form for one contract type.
Returns the editable properties of the named contract type, the choices each may take, and the blank contract a new trade starts from, with defaults resolved against the caller’s current date and time zone. Responses are not cached, so a default reflects the day it was requested. An unknown or not-yet-enabled contract type is reported as a failure rather than an empty form. This synchronous operation is read-only.
curl --request GET \
--url https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.riskportal.activeviam.com/api/TradeBooking/ContractSchema/{contractName}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"$type": "Derivitec.Web.Core.TradeBooking.ApiGetContractSchemaResponse, Derivitec.Web.Core",
"is_success": true,
"error_messages": [
"<string>"
],
"contract_schema": {
"$type": "Derivitec.Web.Core.TradeBooking.ContractSchema, Derivitec.Web.Core",
"contract_name": "<string>",
"contract_description": "<string>",
"manual_page": "<string>",
"controls": [
{
"$type": "Derivitec.Web.Core.TradeBooking.VueControl, Derivitec.Web.Core",
"property_name": "<string>",
"property_options": [
{
"$type": "Derivitec.Web.Core.TradeBooking.VueOption, Derivitec.Web.Core",
"title": "Physical",
"value": "Physical"
}
],
"display_name": "<string>",
"activation_label": "Lower Knockout Active",
"inactive_value": -1,
"input_group": "<string>",
"component": "text_box",
"column_span": 123,
"dictionary_value_vue_controls": "<array>",
"is_multiple_input": true,
"visible_when_property_name": "<string>",
"visible_when_values": [
"<string>"
],
"visible_when_operator": "matches_any",
"currency_pair_property_name": "fx_pair"
}
],
"default_position": {
"$type": "Derivitec.Web.Core.Positions.Position, Derivitec.Web.Core",
"book": "<string>",
"contract_size": 123,
"quantity": 123,
"quantity_traded": 123,
"quantity_currency": "<string>",
"buy_sell": "<string>",
"tradable_id": "<string>",
"trade_action": "<string>",
"client_transaction_id": "<string>",
"counterparty": "<string>",
"structure": "<string>",
"leg": "<string>",
"stamp_derivitec_id": true,
"traded_price_today": 123,
"traded_price_previous": 123,
"dealing_bank": "<string>",
"notes": "<string>",
"trade_date": "2023-11-07T05:31:56Z",
"traded_notional": 123,
"team": "<string>",
"split_by_reporting_currency": true,
"dealer_name": "<string>",
"counterparty_alias": "<string>",
"client": "<string>",
"reference": "<string>",
"product_type": "<string>",
"business_unit": "<string>",
"sub_business_unit": "<string>",
"counterparty_account": "<string>",
"strategy": "<string>",
"entity": "<string>",
"client_tradable_id": "<string>",
"string_label1": "<string>",
"string_label2": "<string>",
"string_label3": "<string>",
"string_label4": "<string>",
"string_label5": "<string>",
"string_label6": "<string>",
"string_label7": "<string>",
"string_label8": "<string>",
"string_label9": "<string>",
"string_label10": "<string>",
"string_label11": "<string>",
"string_label12": "<string>",
"string_label13": "<string>",
"string_label14": "<string>",
"string_label15": "<string>",
"string_label16": "<string>",
"string_label17": "<string>",
"string_label18": "<string>",
"string_label19": "<string>",
"string_label20": "<string>",
"string_label21": "<string>",
"string_label22": "<string>",
"string_label23": "<string>",
"string_label24": "<string>",
"string_label25": "<string>",
"string_label26": "<string>",
"string_label27": "<string>",
"string_label28": "<string>",
"string_label29": "<string>",
"string_label30": "<string>",
"decimal_label1": 123,
"decimal_label2": 123,
"decimal_label3": 123,
"decimal_label4": 123,
"decimal_label5": 123,
"decimal_label6": 123,
"decimal_label7": 123,
"decimal_label8": 123,
"decimal_label9": 123,
"decimal_label10": 123,
"date_label1": "2023-11-07T05:31:56Z",
"date_label2": "2023-11-07T05:31:56Z",
"contract": {
"$type": "Derivitec.Web.Core.Tradables.Ascot, Derivitec.Web.Core",
"identifier": "<string>",
"currency": "<string>",
"expiration_date": "2023-11-07T05:31:56Z",
"asset_swap_spread": 123,
"bond_identifier": {
"$type": "Derivitec.Web.Core.MarketData.InstrumentIdentifier, Derivitec.Web.Core",
"code": "<string>",
"identifier_type": "Derivitec",
"market_identification_code": "<string>"
},
"business_day_convention": "actual",
"calendar_name": "<string>",
"coupon_rate": 123,
"day_count_convention": "actual_actual_icma",
"end_stub": "none",
"end_to_end": true,
"notional": 123,
"payment_lag": 123,
"period_str": "<string>",
"rate_asset_name": "<string>",
"roll_date": "2023-11-07T05:31:56Z",
"start_date": "2023-11-07T05:31:56Z",
"start_stub": "none",
"initial_fx_rate": 123
}
},
"client_security_id": "<string>"
}
}Authorizations
OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header
Path Parameters
The contract type identifier as returned by GetContractTypeNames, for example CmdtyFuture. Matched without regard to case.
Response
Returns the booking form with IsSuccess = true, or IsSuccess = false when the contract type is unknown or not enabled for booking.
The booking form for one contract type, used to render its editor and to start a blank trade.
Derivitec.Web.Core.TradeBooking.ApiGetContractSchemaResponse, Derivitec.Web.Core Whether the operation completed successfully. The default is true; error outcomes set it to false.
true
Messages explaining operation-level failures. The collection is empty by default.
One trade-booking contract form with display text, editable controls, and a default position.
Show child attributes
Show child attributes
Was this page helpful?