Skip to main content
GET
Retrieve the booking form for one contract type.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Path Parameters

contractName
string
required

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.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.TradeBooking.ApiGetContractSchemaResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

contract_schema
object

One trade-booking contract form with display text, editable controls, and a default position.