Bridge

<back to all web services

ETSGetPrice

ETS
The following routes are available for this service:
POST/ETS/Price
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ETSLinkedVesselsViewModel:
    deleted: bool = False
    vessel_id: int = 0
    quantity: Optional[int] = None
    moha_account: Optional[str] = None
    is_quote: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ETSGetPrice:
    order_type: Optional[str] = None
    quantity: int = 0
    insert_quote: bool = False
    linked_vessels: Optional[List[ETSLinkedVesselsViewModel]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetETSForwardPricesForEntityContactSimpleViewModel:
    month_number: int = 0
    starting_date: Optional[datetime.datetime] = None
    date_for_grey_epoch: Optional[str] = None
    date_for_user_interface: Optional[str] = None
    over1000: int = 0
    our_commission_for_order: float = 0.0
    external_fee_per_ticket: float = 0.0
    service_fee_value: float = 0.0
    service_fee_description: Optional[str] = None
    market_price: float = 0.0
    unit_cost_price: float = 0.0
    api_to_use: Optional[str] = None
    spot_additional_margin: Optional[float] = None
    user_contact_number: Optional[str] = None
    aither_settlement_u_u_i_d: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetETSRegistrationStatusViewModel:
    status: Optional[str] = None
    applied_by: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ETSPlaceOrderViewModel:
    order_type: Optional[str] = None
    quote_guid: Optional[str] = None
    unit_price: float = 0.0
    price: float = 0.0
    financing_price: float = 0.0
    financing_status: Optional[str] = None
    arrangement_fee: float = 0.0
    arrangement_fee_description: Optional[str] = None
    ets_order_info_text_non_financed: Optional[str] = None
    ets_order_info_text_financed: Optional[str] = None
    payment_type: Optional[str] = None
    quantity: Optional[int] = None
    original_quantity: Optional[int] = None
    company_name: Optional[str] = None
    full_name: Optional[str] = None
    email_address: Optional[str] = None
    can_purchase_e_u_a: bool = False
    third_party: bool = False
    third_party_name: Optional[str] = None
    external_fee_per_ticket: float = 0.0
    our_commission_for_order: float = 0.0
    eua_price: float = 0.0
    raw_price: float = 0.0
    regenerate_quote: bool = False
    get_e_t_s_market_hours_message: Optional[str] = None
    is_bridge_client: bool = False
    api_to_use: Optional[str] = None
    ioi_id: Optional[str] = None
    offer_ioi: Optional[str] = None
    ioi_expires_at: datetime.datetime = datetime.datetime(1, 1, 1)
    spot_additional_margin: Decimal = decimal.Decimal(0)
    aither_settlement_u_u_i_d: Optional[str] = None
    get_vessels: Optional[List[SelectListItem]] = None
    linked_vessels: Optional[List[ETSLinkedVesselsViewModel]] = None
    get_e_t_s_forward_prices_for_entity_contact_simple: Optional[List[GetETSForwardPricesForEntityContactSimpleViewModel]] = None
    get_e_t_s_registration_status: Optional[GetETSRegistrationStatusViewModel] = None

Python ETSGetPrice DTOs

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.

POST /ETS/Price HTTP/1.1 
Host: internal.thebunkerbridge.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	OrderType: String,
	Quantity: 0,
	InsertQuote: False,
	LinkedVessels: 
	[
		{
			Deleted: False,
			VesselId: 0,
			Quantity: 0,
			MohaAccount: String,
			IsQuote: False
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	OrderType: String,
	QuoteGuid: 00000000000000000000000000000000,
	UnitPrice: 0,
	Price: 0,
	FinancingPrice: 0,
	FinancingStatus: String,
	ArrangementFee: 0,
	ArrangementFeeDescription: String,
	ETSOrderInfoTextNonFinanced: String,
	ETSOrderInfoTextFinanced: String,
	PaymentType: String,
	Quantity: 0,
	OriginalQuantity: 0,
	CompanyName: String,
	FullName: String,
	EmailAddress: String,
	CanPurchaseEUA: False,
	ThirdParty: False,
	ThirdPartyName: String,
	ExternalFeePerTicket: 0,
	OurCommissionForOrder: 0,
	EUAPrice: 0,
	RawPrice: 0,
	RegenerateQuote: False,
	GetETSMarketHoursMessage: String,
	IsBridgeClient: False,
	APIToUse: String,
	IoiId: String,
	OfferIoi: String,
	IoiExpiresAt: 0001-01-01,
	SpotAdditionalMargin: 0,
	AitherSettlementUUID: String,
	GetVessels: 
	[
		{
			Disabled: False,
			Group: 
			{
				Disabled: False,
				Name: String
			},
			Selected: False,
			Text: String,
			Value: String
		}
	],
	LinkedVessels: 
	[
		{
			Deleted: False,
			VesselId: 0,
			Quantity: 0,
			MohaAccount: String,
			IsQuote: False
		}
	],
	GetETSForwardPricesForEntityContactSimple: 
	[
		{
			MonthNumber: 0,
			StartingDate: 0001-01-01,
			DateForGreyEpoch: String,
			DateForUserInterface: String,
			Over1000: 0,
			OurCommissionForOrder: 0,
			ExternalFeePerTicket: 0,
			ServiceFeeValue: 0,
			ServiceFeeDescription: String,
			MarketPrice: 0,
			UnitCostPrice: 0,
			APIToUse: String,
			SpotAdditionalMargin: 0,
			UserContactNumber: String,
			AitherSettlementUUID: String
		}
	],
	GetETSRegistrationStatus: 
	{
		Status: String,
		AppliedBy: String
	}
}