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

<ETSPlaceOrderForwardSubmit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bridge.Private.Api.DTO">
  <GetETSRegistrationStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bridge.Core.ViewModels">
    <d2p1:AppliedBy>String</d2p1:AppliedBy>
    <d2p1:Status>String</d2p1:Status>
  </GetETSRegistrationStatus>
  <InvoicedBy>String</InvoicedBy>
  <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>
  <MonthNumber>0</MonthNumber>
  <Quantity>0</Quantity>
  <QuoteGuid>00000000-0000-0000-0000-000000000000</QuoteGuid>
  <SelectedForwardOption>String</SelectedForwardOption>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <ThirdParty>false</ThirdParty>
  <ThirdPartyName>String</ThirdPartyName>
</ETSPlaceOrderForwardSubmit>

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

<SavingResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bridge.Core.Results">
  <Errors>
    <SavingResultErrors>
      <Error>String</Error>
    </SavingResultErrors>
  </Errors>
  <GuidId>00000000-0000-0000-0000-000000000000</GuidId>
  <Id>0</Id>
  <Status>Success</Status>
</SavingResult>