Bridge

<back to all web services

DealRecap

Deal Recaps
The following routes are available for this service:
GET/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 DealRecap:
    guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetRecapDetailsViewModel:
    guid: Optional[str] = None
    document_title: Optional[str] = None
    general_comments: Optional[str] = None
    enquiry_id: int = 0
    enquiry_guid: Optional[str] = None
    company_logo: Optional[bytes] = None
    from_contact_name: Optional[str] = None
    contact_guid: Optional[str] = None
    entity_name: Optional[str] = None
    vessel_name: Optional[str] = None
    imo_number: int = 0
    port_code: Optional[str] = None
    port_name: Optional[str] = None
    country_name: Optional[str] = None
    country_flag: Optional[bytes] = None
    date_from: datetime.datetime = datetime.datetime(1, 1, 1)
    date_to: datetime.datetime = datetime.datetime(1, 1, 1)
    buyer_account_name: Optional[str] = None
    delivery_method: Optional[str] = None
    agent_details: Optional[str] = None
    recap_terms: Optional[str] = None
    additional_costs: Optional[str] = None
    recap_grades: Optional[str] = None
    accepted: Optional[bool] = None
    rejected: Optional[bool] = None
    from_entity_contact_id: int = 0
    to_entity_contact_id: int = 0
    recap_comments: Optional[str] = None
    terms_and_conditions: Optional[str] = None
    image_guid: Optional[str] = None
    vessel_id: int = 0
    confirmation_only: bool = False

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

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

{
	Guid: 00000000000000000000000000000000,
	DocumentTitle: String,
	GeneralComments: String,
	EnquiryId: 0,
	EnquiryGuid: 00000000000000000000000000000000,
	CompanyLogo: AA==,
	FromContactName: String,
	ContactGuid: 00000000000000000000000000000000,
	EntityName: String,
	VesselName: String,
	IMONumber: 0,
	PortCode: String,
	PortName: String,
	CountryName: String,
	CountryFlag: AA==,
	DateFrom: 0001-01-01,
	DateTo: 0001-01-01,
	BuyerAccountName: String,
	DeliveryMethod: String,
	AgentDetails: String,
	RecapTerms: String,
	AdditionalCosts: String,
	RecapGrades: String,
	Accepted: False,
	Rejected: False,
	FromEntityContactId: 0,
	ToEntityContactId: 0,
	RecapComments: String,
	TermsAndConditions: String,
	ImageGuid: 00000000000000000000000000000000,
	VesselId: 0,
	ConfirmationOnly: False
}