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 .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
	}
}