Bridge

<back to all web services

ETSPlaceOrderForwardSubmit

ETS
The following routes are available for this service:
POST/ETS/Forward/Place-Order
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 GetETSRegistrationStatusViewModel:
    status: Optional[str] = None
    applied_by: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ETSPlaceOrderForwardSubmit:
    quote_guid: Optional[str] = None
    quantity: int = 0
    month_number: int = 0
    start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    invoiced_by: Optional[str] = None
    selected_forward_option: Optional[str] = None
    third_party: bool = False
    third_party_name: Optional[str] = None
    linked_vessels: Optional[List[ETSLinkedVesselsViewModel]] = None
    get_e_t_s_registration_status: Optional[GetETSRegistrationStatusViewModel] = None


class SavingResultStatus(str, Enum):
    SUCCESS = 'Success'
    ERROR = 'Error'


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SavingResult:
    id: Optional[int] = None
    guid_id: Optional[str] = None
    status: Optional[SavingResultStatus] = None
    errors: Optional[List[SavingResultErrors]] = None

Python ETSPlaceOrderForwardSubmit 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/Forward/Place-Order HTTP/1.1 
Host: internal.thebunkerbridge.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	QuoteGuid: 00000000000000000000000000000000,
	Quantity: 0,
	MonthNumber: 0,
	StartDate: 0001-01-01,
	InvoicedBy: String,
	SelectedForwardOption: String,
	ThirdParty: False,
	ThirdPartyName: String,
	LinkedVessels: 
	[
		{
			Deleted: False,
			VesselId: 0,
			Quantity: 0,
			MohaAccount: String,
			IsQuote: False
		}
	],
	GetETSRegistrationStatus: 
	{
		Status: String,
		AppliedBy: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	GuidId: 00000000000000000000000000000000,
	Status: Success,
	Errors: 
	[
		{
			Error: String
		}
	]
}