Bridge

<back to all web services

SendDealRecap

Deal Recaps
The following routes are available for this service:
GET/Send-Deal-Recap
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 SendDealRecap:
    guid: Optional[str] = None
    from_entity_contact_id: int = 0
    chat_guid: Optional[str] = None
    to_buyer_contact_id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPortListViewModel:
    id: int = 0
    guid: Optional[str] = None
    name: Optional[str] = None
    code: Optional[str] = None
    latitude: float = 0.0
    longitude: float = 0.0
    country_id: int = 0
    country_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDeliveryMethodsViewModel:
    id: int = 0
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetProductsViewModel:
    id: int = 0
    index: int = 0
    name: Optional[str] = None
    deleted: bool = False
    ets_multiplication: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EntityAccountsViewModel:
    id: int = 0
    type: Optional[str] = None
    name: Optional[str] = None
    linked_vessel_id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetVersionsViewModel:
    id: int = 0
    index: int = 0
    name: Optional[str] = None
    deleted: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetGradesViewModel:
    id: int = 0
    index: int = 0
    name: Optional[str] = None
    deleted: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetUnitsViewModel:
    id: int = 0
    code: Optional[str] = None
    deleted: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCurrenciesViewModel:
    id: int = 0
    code: Optional[str] = None
    description: Optional[str] = None
    symbol: Optional[str] = None
    index: int = 0
    deleted: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DealRecapEnquiryGradesViewModel:
    id: Optional[int] = None
    deleted: bool = False
    product_id: Optional[int] = None
    version_id: Optional[int] = None
    grade_id: Optional[int] = None
    specification_comments: Optional[str] = None
    volume_from: Optional[int] = None
    volume_to: Optional[int] = None
    unit_id: Optional[int] = None
    volume_unit_id: Optional[int] = None
    unit_price: Optional[float] = None
    currency_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class APISendDealRecapViewModel:
    enquiry_id: int = 0
    enquiry_guid: Optional[str] = None
    chat_guid: Optional[str] = None
    imo_number: int = 0
    vessel_id: int = 0
    vessel_name: Optional[str] = None
    buyer_account_name: Optional[str] = None
    date_from: Optional[datetime.datetime] = None
    date_to: Optional[datetime.datetime] = None
    port_id: Optional[int] = None
    delivery_method_id: Optional[int] = None
    buyer_seller_account_id: Optional[int] = None
    requested_terms_type: Optional[str] = None
    credit_term_days: Optional[int] = None
    recap_comments: Optional[str] = None
    agent: Optional[str] = None
    additional_costs: Optional[str] = None
    from_entity_contact_id: int = 0
    document_title: Optional[str] = None
    recap_can_be_sent: bool = False
    get_port_list: Optional[List[GetPortListViewModel]] = None
    get_delivery_methods: Optional[List[GetDeliveryMethodsViewModel]] = None
    get_products: Optional[List[GetProductsViewModel]] = None
    get_buyer_seller_accounts: Optional[List[EntityAccountsViewModel]] = None
    get_versions: Optional[List[GetVersionsViewModel]] = None
    get_grades: Optional[List[GetGradesViewModel]] = None
    get_units: Optional[List[GetUnitsViewModel]] = None
    get_currencies: Optional[List[GetCurrenciesViewModel]] = None
    deal_recap_enquiry_grades: Optional[List[DealRecapEnquiryGradesViewModel]] = None

Python SendDealRecap 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.

GET /Send-Deal-Recap HTTP/1.1 
Host: internal.thebunkerbridge.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<APISendDealRecapViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bridge.Core.ViewModels">
  <AdditionalCosts>String</AdditionalCosts>
  <Agent>String</Agent>
  <BuyerAccountName>String</BuyerAccountName>
  <BuyerSellerAccountId>0</BuyerSellerAccountId>
  <ChatGuid>00000000-0000-0000-0000-000000000000</ChatGuid>
  <CreditTermDays>0</CreditTermDays>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <DealRecapEnquiryGrades>
    <DealRecapEnquiryGradesViewModel>
      <CurrencyId>0</CurrencyId>
      <Deleted>false</Deleted>
      <GradeId>0</GradeId>
      <Id>0</Id>
      <ProductId>0</ProductId>
      <SpecificationComments>String</SpecificationComments>
      <UnitId>0</UnitId>
      <UnitPrice>0</UnitPrice>
      <VersionId>0</VersionId>
      <VolumeFrom>0</VolumeFrom>
      <VolumeTo>0</VolumeTo>
      <VolumeUnitId>0</VolumeUnitId>
    </DealRecapEnquiryGradesViewModel>
  </DealRecapEnquiryGrades>
  <DeliveryMethodId>0</DeliveryMethodId>
  <DocumentTitle>String</DocumentTitle>
  <EnquiryGuid>00000000-0000-0000-0000-000000000000</EnquiryGuid>
  <EnquiryId>0</EnquiryId>
  <FromEntityContactId>0</FromEntityContactId>
  <GetBuyerSellerAccounts>
    <EntityAccountsViewModel>
      <Id>0</Id>
      <LinkedVesselId>0</LinkedVesselId>
      <Name>String</Name>
      <Type>String</Type>
    </EntityAccountsViewModel>
  </GetBuyerSellerAccounts>
  <GetCurrencies>
    <GetCurrenciesViewModel>
      <Code>String</Code>
      <Deleted>false</Deleted>
      <Description>String</Description>
      <Id>0</Id>
      <Index>0</Index>
      <Symbol>String</Symbol>
    </GetCurrenciesViewModel>
  </GetCurrencies>
  <GetDeliveryMethods>
    <GetDeliveryMethodsViewModel>
      <Id>0</Id>
      <Name>String</Name>
    </GetDeliveryMethodsViewModel>
  </GetDeliveryMethods>
  <GetGrades>
    <GetGradesViewModel>
      <Deleted>false</Deleted>
      <Id>0</Id>
      <Index>0</Index>
      <Name>String</Name>
    </GetGradesViewModel>
  </GetGrades>
  <GetPortList>
    <GetPortListViewModel>
      <Code>String</Code>
      <CountryId>0</CountryId>
      <CountryName>String</CountryName>
      <Guid>00000000-0000-0000-0000-000000000000</Guid>
      <Id>0</Id>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <Name>String</Name>
    </GetPortListViewModel>
  </GetPortList>
  <GetProducts>
    <GetProductsViewModel>
      <Deleted>false</Deleted>
      <ETSMultiplication>0</ETSMultiplication>
      <Id>0</Id>
      <Index>0</Index>
      <Name>String</Name>
    </GetProductsViewModel>
  </GetProducts>
  <GetUnits>
    <GetUnitsViewModel>
      <Code>String</Code>
      <Deleted>false</Deleted>
      <Id>0</Id>
    </GetUnitsViewModel>
  </GetUnits>
  <GetVersions>
    <GetVersionsViewModel>
      <Deleted>false</Deleted>
      <Id>0</Id>
      <Index>0</Index>
      <Name>String</Name>
    </GetVersionsViewModel>
  </GetVersions>
  <IMONumber>0</IMONumber>
  <PortId>0</PortId>
  <RecapCanBeSent>false</RecapCanBeSent>
  <RecapComments>String</RecapComments>
  <RequestedTermsType>String</RequestedTermsType>
  <VesselId>0</VesselId>
  <VesselName>String</VesselName>
</APISendDealRecapViewModel>