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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ETSGetPrice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bridge.Private.Api.DTO">
  <InsertQuote>false</InsertQuote>
  <LinkedVessels xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bridge.Core.ViewModels">
    <d2p1:ETSLinkedVesselsViewModel>
      <d2p1:Deleted>false</d2p1:Deleted>
      <d2p1:IsQuote>false</d2p1:IsQuote>
      <d2p1:MohaAccount>String</d2p1:MohaAccount>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:VesselId>0</d2p1:VesselId>
    </d2p1:ETSLinkedVesselsViewModel>
  </LinkedVessels>
  <OrderType>String</OrderType>
  <Quantity>0</Quantity>
</ETSGetPrice>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ETSPlaceOrderViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bridge.Core.ViewModels">
  <APIToUse>String</APIToUse>
  <AitherSettlementUUID>String</AitherSettlementUUID>
  <ArrangementFee>0</ArrangementFee>
  <ArrangementFeeDescription>String</ArrangementFeeDescription>
  <CanPurchaseEUA>false</CanPurchaseEUA>
  <CompanyName>String</CompanyName>
  <ETSOrderInfoTextFinanced>String</ETSOrderInfoTextFinanced>
  <ETSOrderInfoTextNonFinanced>String</ETSOrderInfoTextNonFinanced>
  <EUAPrice>0</EUAPrice>
  <EmailAddress>String</EmailAddress>
  <ExternalFeePerTicket>0</ExternalFeePerTicket>
  <FinancingPrice>0</FinancingPrice>
  <FinancingStatus>String</FinancingStatus>
  <FullName>String</FullName>
  <GetETSForwardPricesForEntityContactSimple>
    <GetETSForwardPricesForEntityContactSimpleViewModel>
      <APIToUse>String</APIToUse>
      <AitherSettlementUUID>String</AitherSettlementUUID>
      <DateForGreyEpoch>String</DateForGreyEpoch>
      <DateForUserInterface>String</DateForUserInterface>
      <ExternalFeePerTicket>0</ExternalFeePerTicket>
      <MarketPrice>0</MarketPrice>
      <MonthNumber>0</MonthNumber>
      <OurCommissionForOrder>0</OurCommissionForOrder>
      <Over1000>0</Over1000>
      <ServiceFeeDescription>String</ServiceFeeDescription>
      <ServiceFeeValue>0</ServiceFeeValue>
      <SpotAdditionalMargin>0</SpotAdditionalMargin>
      <StartingDate>0001-01-01T00:00:00</StartingDate>
      <UnitCostPrice>0</UnitCostPrice>
      <UserContactNumber>String</UserContactNumber>
    </GetETSForwardPricesForEntityContactSimpleViewModel>
  </GetETSForwardPricesForEntityContactSimple>
  <GetETSMarketHoursMessage>String</GetETSMarketHoursMessage>
  <GetETSRegistrationStatus>
    <AppliedBy>String</AppliedBy>
    <Status>String</Status>
  </GetETSRegistrationStatus>
  <GetVessels xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc">
    <d2p1:SelectListItem>
      <d2p1:Disabled>false</d2p1:Disabled>
      <d2p1:Group>
        <d2p1:Disabled>false</d2p1:Disabled>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:Group>
      <d2p1:Selected>false</d2p1:Selected>
      <d2p1:Text>String</d2p1:Text>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:SelectListItem>
  </GetVessels>
  <IoiExpiresAt>0001-01-01T00:00:00</IoiExpiresAt>
  <IoiId>String</IoiId>
  <IsBridgeClient>false</IsBridgeClient>
  <LinkedVessels>
    <ETSLinkedVesselsViewModel>
      <Deleted>false</Deleted>
      <IsQuote>false</IsQuote>
      <MohaAccount>String</MohaAccount>
      <Quantity>0</Quantity>
      <VesselId>0</VesselId>
    </ETSLinkedVesselsViewModel>
  </LinkedVessels>
  <OfferIoi>String</OfferIoi>
  <OrderType>String</OrderType>
  <OriginalQuantity>0</OriginalQuantity>
  <OurCommissionForOrder>0</OurCommissionForOrder>
  <PaymentType>String</PaymentType>
  <Price>0</Price>
  <Quantity>0</Quantity>
  <QuoteGuid>00000000-0000-0000-0000-000000000000</QuoteGuid>
  <RawPrice>0</RawPrice>
  <RegenerateQuote>false</RegenerateQuote>
  <SpotAdditionalMargin>0</SpotAdditionalMargin>
  <ThirdParty>false</ThirdParty>
  <ThirdPartyName>String</ThirdPartyName>
  <UnitPrice>0</UnitPrice>
</ETSPlaceOrderViewModel>