Bridge

<back to all web services

EnquiriesHistory

Enquiries
The following routes are available for this service:
GET/Enquiries/History
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 EnquiriesHistory:
    just_my_enquiries: bool = False
    can_view_company_enquiries: bool = False
    vessel_id: Optional[int] = None
    port_of_supply_id: Optional[int] = None
    closed_deals_only: Optional[bool] = None
    supplier_id: Optional[int] = None
    date_from: Optional[datetime.datetime] = None
    date_to: Optional[datetime.datetime] = None
    status: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEnquiryHistoryForContactFiltersViewModel:
    just_my_enquiries: bool = False
    can_view_company_enquiries: bool = False
    vessel_id: Optional[int] = None
    port_of_supply_id: Optional[int] = None
    closed_deals_only: Optional[bool] = None
    supplier_id: Optional[int] = None
    date_from: Optional[datetime.datetime] = None
    date_to: Optional[datetime.datetime] = None
    status: Optional[str] = None
    filters: Optional[List[GetFilterValuesForContactEntityViewModel]] = None
    vessels_list: Optional[List[SelectListItem]] = None
    port_of_supplies_list: Optional[List[SelectListItem]] = None
    enquiries_with_list: Optional[List[SelectListItem]] = None
    enquiry_statuses_list: Optional[List[SelectListItem]] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetEnquiryHistoryForContactViewModel:
    enquiry_id: int = 0
    enquiry_guid: Optional[str] = None
    flag_round: Optional[bytes] = None
    country_name: Optional[str] = None
    port_name: Optional[str] = None
    latitude: float = 0.0
    longitude: float = 0.0
    vessel_name: Optional[str] = None
    imo_number: int = 0
    delivery_date: Optional[str] = None
    recap_accepted: bool = False
    recap_from_company: Optional[str] = None
    recap_from_name: Optional[str] = None
    recap_from_entity_contact_guid: Optional[str] = None
    recap_to_company: Optional[str] = None
    recap_to_name: Optional[str] = None
    recap_to_entity_contact_guid: Optional[str] = None
    deal_with_company_and_contact: Optional[str] = None
    recap_guid: Optional[str] = None
    recap_from_entity_contact_image_guid: Optional[str] = None
    recap_to_entity_contact_image_guid: Optional[str] = None
    worked_on_by: Optional[List[GetLiveEnquiriesForContactAndEntityBeingWorkedOnByListViewModel]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EnquiryHistoryViewModel:
    get_enquiry_history_for_contact_filters: Optional[GetEnquiryHistoryForContactFiltersViewModel] = None
    get_enquiry_history_for_contact: Optional[List[GetEnquiryHistoryForContactViewModel]] = None

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

<EnquiryHistoryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bridge.Core.ViewModels">
  <GetEnquiryHistoryForContact>
    <GetEnquiryHistoryForContactViewModel>
      <CountryName>String</CountryName>
      <DealWithCompanyAndContact>String</DealWithCompanyAndContact>
      <DeliveryDate>String</DeliveryDate>
      <EnquiryGuid>00000000-0000-0000-0000-000000000000</EnquiryGuid>
      <EnquiryId>0</EnquiryId>
      <FlagRound>AA==</FlagRound>
      <IMONumber>0</IMONumber>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <PortName>String</PortName>
      <RecapAccepted>false</RecapAccepted>
      <RecapFromCompany>String</RecapFromCompany>
      <RecapFromEntityContactGuid>00000000-0000-0000-0000-000000000000</RecapFromEntityContactGuid>
      <RecapFromEntityContactImageGuid>00000000-0000-0000-0000-000000000000</RecapFromEntityContactImageGuid>
      <RecapFromName>String</RecapFromName>
      <RecapGuid>00000000-0000-0000-0000-000000000000</RecapGuid>
      <RecapToCompany>String</RecapToCompany>
      <RecapToEntityContactGuid>00000000-0000-0000-0000-000000000000</RecapToEntityContactGuid>
      <RecapToEntityContactImageGuid>00000000-0000-0000-0000-000000000000</RecapToEntityContactImageGuid>
      <RecapToName>String</RecapToName>
      <VesselName>String</VesselName>
      <WorkedOnBy>
        <GetLiveEnquiriesForContactAndEntityBeingWorkedOnByListViewModel>
          <HandlingEnquiryName>String</HandlingEnquiryName>
        </GetLiveEnquiriesForContactAndEntityBeingWorkedOnByListViewModel>
      </WorkedOnBy>
    </GetEnquiryHistoryForContactViewModel>
  </GetEnquiryHistoryForContact>
  <GetEnquiryHistoryForContactFilters>
    <CanViewCompanyEnquiries>false</CanViewCompanyEnquiries>
    <ClosedDealsOnly>false</ClosedDealsOnly>
    <DateFrom>0001-01-01T00:00:00</DateFrom>
    <DateTo>0001-01-01T00:00:00</DateTo>
    <EnquiriesWithList xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc">
      <d3p1:SelectListItem>
        <d3p1:Disabled>false</d3p1:Disabled>
        <d3p1:Group>
          <d3p1:Disabled>false</d3p1:Disabled>
          <d3p1:Name>String</d3p1:Name>
        </d3p1:Group>
        <d3p1:Selected>false</d3p1:Selected>
        <d3p1:Text>String</d3p1:Text>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:SelectListItem>
    </EnquiriesWithList>
    <EnquiryStatusesList xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc">
      <d3p1:SelectListItem>
        <d3p1:Disabled>false</d3p1:Disabled>
        <d3p1:Group>
          <d3p1:Disabled>false</d3p1:Disabled>
          <d3p1:Name>String</d3p1:Name>
        </d3p1:Group>
        <d3p1:Selected>false</d3p1:Selected>
        <d3p1:Text>String</d3p1:Text>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:SelectListItem>
    </EnquiryStatusesList>
    <Filters>
      <GetFilterValuesForContactEntityViewModel>
        <Id>0</Id>
        <Text>String</Text>
        <Type>String</Type>
      </GetFilterValuesForContactEntityViewModel>
    </Filters>
    <JustMyEnquiries>false</JustMyEnquiries>
    <PortOfSuppliesList xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc">
      <d3p1:SelectListItem>
        <d3p1:Disabled>false</d3p1:Disabled>
        <d3p1:Group>
          <d3p1:Disabled>false</d3p1:Disabled>
          <d3p1:Name>String</d3p1:Name>
        </d3p1:Group>
        <d3p1:Selected>false</d3p1:Selected>
        <d3p1:Text>String</d3p1:Text>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:SelectListItem>
    </PortOfSuppliesList>
    <PortOfSupplyId>0</PortOfSupplyId>
    <Status>String</Status>
    <SupplierId>0</SupplierId>
    <VesselId>0</VesselId>
    <VesselsList xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc">
      <d3p1:SelectListItem>
        <d3p1:Disabled>false</d3p1:Disabled>
        <d3p1:Group>
          <d3p1:Disabled>false</d3p1:Disabled>
          <d3p1:Name>String</d3p1:Name>
        </d3p1:Group>
        <d3p1:Selected>false</d3p1:Selected>
        <d3p1:Text>String</d3p1:Text>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:SelectListItem>
    </VesselsList>
  </GetEnquiryHistoryForContactFilters>
</EnquiryHistoryViewModel>