Bridge

<back to all web services

ETSGetPrice

ETS
The following routes are available for this service:
POST/ETS/Price

export class ETSLinkedVesselsViewModel
{
    public Deleted: boolean;
    public VesselId: number;
    public Quantity?: number;
    public MohaAccount: string;
    public IsQuote: boolean;

    public constructor(init?: Partial<ETSLinkedVesselsViewModel>) { (Object as any).assign(this, init); }
}

export class ETSGetPrice
{
    public OrderType: string;
    public Quantity: number;
    public InsertQuote: boolean;
    public LinkedVessels: ETSLinkedVesselsViewModel[];

    public constructor(init?: Partial<ETSGetPrice>) { (Object as any).assign(this, init); }
}

export class GetETSForwardPricesForEntityContactSimpleViewModel
{
    public MonthNumber: number;
    public StartingDate?: string;
    public DateForGreyEpoch: string;
    public DateForUserInterface: string;
    public Over1000: number;
    public OurCommissionForOrder: number;
    public ExternalFeePerTicket: number;
    public ServiceFeeValue: number;
    public ServiceFeeDescription: string;
    public MarketPrice: number;
    public UnitCostPrice: number;
    public APIToUse: string;
    public SpotAdditionalMargin?: number;
    public UserContactNumber: string;
    public AitherSettlementUUID: string;

    public constructor(init?: Partial<GetETSForwardPricesForEntityContactSimpleViewModel>) { (Object as any).assign(this, init); }
}

export class GetETSRegistrationStatusViewModel
{
    public Status: string;
    public AppliedBy: string;

    public constructor(init?: Partial<GetETSRegistrationStatusViewModel>) { (Object as any).assign(this, init); }
}

export class ETSPlaceOrderViewModel
{
    public OrderType: string;
    public QuoteGuid: string;
    public UnitPrice: number;
    public Price: number;
    public FinancingPrice: number;
    public FinancingStatus: string;
    public ArrangementFee: number;
    public ArrangementFeeDescription: string;
    public ETSOrderInfoTextNonFinanced: string;
    public ETSOrderInfoTextFinanced: string;
    public PaymentType: string;
    public Quantity?: number;
    public OriginalQuantity?: number;
    public CompanyName: string;
    public FullName: string;
    public EmailAddress: string;
    public CanPurchaseEUA: boolean;
    public ThirdParty: boolean;
    public ThirdPartyName: string;
    public ExternalFeePerTicket: number;
    public OurCommissionForOrder: number;
    public EUAPrice: number;
    public RawPrice: number;
    public RegenerateQuote: boolean;
    public GetETSMarketHoursMessage: string;
    public IsBridgeClient: boolean;
    public APIToUse: string;
    public IoiId: string;
    public OfferIoi: string;
    public IoiExpiresAt: string;
    public SpotAdditionalMargin: number;
    public AitherSettlementUUID: string;
    public GetVessels: SelectListItem[];
    public LinkedVessels: ETSLinkedVesselsViewModel[];
    public GetETSForwardPricesForEntityContactSimple: GetETSForwardPricesForEntityContactSimpleViewModel[];
    public GetETSRegistrationStatus: GetETSRegistrationStatusViewModel;

    public constructor(init?: Partial<ETSPlaceOrderViewModel>) { (Object as any).assign(this, init); }
}

TypeScript 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>