Bridge

<back to all web services

EnquiriesDetails

Enquiries
The following routes are available for this service:
GET/Enquiries/Details
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 EnquiriesDetails:
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EntityViewModel:
    id: int = 0
    guid: Optional[str] = None
    type: Optional[str] = None
    name: Optional[str] = None
    super_trader: bool = False
    company_domain: Optional[str] = None
    kyc_started_by: int = 0
    kyc_completed_by: int = 0
    etsmoha_account: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAllAccessLevelsForEntityContactIdViewModel:
    id: int = 0
    allowed: bool = False
    name: Optional[str] = None
    description: Optional[str] = None
    pretty_text: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EntityContactViewModel:
    id: int = 0
    guid: Optional[str] = None
    entity_id: int = 0
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    initials: Optional[str] = None
    password: Optional[str] = None
    email_address: Optional[str] = None
    dark_mode: bool = False
    entity: Optional[EntityViewModel] = None
    last_active: Optional[datetime.datetime] = None
    image_guid: Optional[str] = None
    dialing_code_country_id: Optional[int] = None
    telephone_number: Optional[str] = None
    is_bridge_client: bool = False
    access_levels: Optional[List[GetAllAccessLevelsForEntityContactIdViewModel]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEnquiryGradesViewModel:
    id: int = 0
    quantity_from: int = 0
    quantity_to: int = 0
    quantity: Optional[str] = None
    comments: Optional[str] = None
    grade: Optional[str] = None
    product_id: int = 0
    version_id: int = 0
    grade_id: int = 0
    unit_id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEnquiryDetailsViewModel:
    id: int = 0
    access_code: int = 0
    entity_contact_id: int = 0
    guid: Optional[str] = None
    port_code: Optional[str] = None
    port_name: Optional[str] = None
    country_name: Optional[str] = None
    flag_round: Optional[bytes] = None
    date_from: datetime.datetime = datetime.datetime(1, 1, 1)
    date_to: datetime.datetime = datetime.datetime(1, 1, 1)
    agent_name: Optional[str] = None
    buyer_account_name: Optional[str] = None
    request_terms: Optional[str] = None
    general_comments: Optional[str] = None
    vessel_name: Optional[str] = None
    imo_number: int = 0
    scratchpad_id: int = 0
    scratchpad: Optional[str] = None
    delivery_method: Optional[str] = None
    single_chat_guid: Optional[str] = None
    single_chat_entity_id: int = 0
    total_chats: int = 0
    chat_ids: Optional[List[str]] = None
    risk_rating_subscription_status: bool = False
    windward_report_live: bool = False
    windward_report_expiry_date_time: datetime.datetime = datetime.datetime(1, 1, 1)
    latest_r_a_g_status: Optional[str] = None
    vessel_windward_url: Optional[str] = None
    port_id: int = 0
    can_forward_enquiry: bool = False
    vessel_id: int = 0
    delivery_method_id: Optional[int] = None
    credit_term_days: int = 0
    requested_terms_type: Optional[str] = None
    button_group: Optional[str] = None
    can_send_broadcast_chat: bool = False
    account_id: int = 0
    chat_list: Optional[str] = None
    entity_contact: Optional[EntityContactViewModel] = None
    get_enquiry_grades: Optional[List[GetEnquiryGradesViewModel]] = None

Python EnquiriesDetails 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 /Enquiries/Details HTTP/1.1 
Host: internal.thebunkerbridge.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetEnquiryDetailsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bridge.Core.ViewModels">
  <AccessCode>0</AccessCode>
  <AccountId>0</AccountId>
  <AgentName>String</AgentName>
  <ButtonGroup>String</ButtonGroup>
  <BuyerAccountName>String</BuyerAccountName>
  <CanForwardEnquiry>false</CanForwardEnquiry>
  <CanSendBroadcastChat>false</CanSendBroadcastChat>
  <ChatIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </ChatIds>
  <ChatList>String</ChatList>
  <CountryName>String</CountryName>
  <CreditTermDays>0</CreditTermDays>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <DeliveryMethod>String</DeliveryMethod>
  <DeliveryMethodId>0</DeliveryMethodId>
  <EntityContact>
    <AccessLevels>
      <GetAllAccessLevelsForEntityContactIdViewModel>
        <Allowed>false</Allowed>
        <Description>String</Description>
        <Id>0</Id>
        <Name>String</Name>
        <PrettyText>String</PrettyText>
      </GetAllAccessLevelsForEntityContactIdViewModel>
    </AccessLevels>
    <DarkMode>false</DarkMode>
    <DialingCodeCountryId>0</DialingCodeCountryId>
    <EmailAddress>String</EmailAddress>
    <Entity>
      <CompanyDomain>String</CompanyDomain>
      <ETSMOHAAccount>String</ETSMOHAAccount>
      <Guid>00000000-0000-0000-0000-000000000000</Guid>
      <Id>0</Id>
      <KYCCompletedBy>0</KYCCompletedBy>
      <KYCStartedBy>0</KYCStartedBy>
      <Name>String</Name>
      <SuperTrader>false</SuperTrader>
      <Type>String</Type>
    </Entity>
    <EntityId>0</EntityId>
    <FirstName>String</FirstName>
    <Guid>00000000-0000-0000-0000-000000000000</Guid>
    <Id>0</Id>
    <ImageGuid>00000000-0000-0000-0000-000000000000</ImageGuid>
    <Initials>String</Initials>
    <IsBridgeClient>false</IsBridgeClient>
    <LastActive>0001-01-01T00:00:00</LastActive>
    <LastName>String</LastName>
    <Password>String</Password>
    <TelephoneNumber>String</TelephoneNumber>
  </EntityContact>
  <EntityContactId>0</EntityContactId>
  <FlagRound>AA==</FlagRound>
  <GeneralComments>String</GeneralComments>
  <GetEnquiryGrades>
    <GetEnquiryGradesViewModel>
      <Comments>String</Comments>
      <Grade>String</Grade>
      <GradeId>0</GradeId>
      <Id>0</Id>
      <ProductId>0</ProductId>
      <Quantity>String</Quantity>
      <QuantityFrom>0</QuantityFrom>
      <QuantityTo>0</QuantityTo>
      <UnitId>0</UnitId>
      <VersionId>0</VersionId>
    </GetEnquiryGradesViewModel>
  </GetEnquiryGrades>
  <Guid>00000000-0000-0000-0000-000000000000</Guid>
  <IMONumber>0</IMONumber>
  <Id>0</Id>
  <LatestRAGStatus>String</LatestRAGStatus>
  <PortCode>String</PortCode>
  <PortId>0</PortId>
  <PortName>String</PortName>
  <RequestTerms>String</RequestTerms>
  <RequestedTermsType>String</RequestedTermsType>
  <RiskRatingSubscriptionStatus>false</RiskRatingSubscriptionStatus>
  <Scratchpad>String</Scratchpad>
  <ScratchpadId>0</ScratchpadId>
  <SingleChatEntityId>0</SingleChatEntityId>
  <SingleChatGuid>00000000-0000-0000-0000-000000000000</SingleChatGuid>
  <TotalChats>0</TotalChats>
  <VesselId>0</VesselId>
  <VesselName>String</VesselName>
  <VesselWindwardUrl>String</VesselWindwardUrl>
  <WindwardReportExpiryDateTime>0001-01-01T00:00:00</WindwardReportExpiryDateTime>
  <WindwardReportLive>false</WindwardReportLive>
</GetEnquiryDetailsViewModel>