| POST | /Enquiries/Create |
|---|
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 CreateEnquiryGradesViewModel:
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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EnquiryCreate:
account_id: Optional[int] = None
agent: Optional[str] = None
buyer_email_address: Optional[str] = None
buyer_company: Optional[str] = None
credit_term_days: Optional[int] = None
date_from: Optional[datetime.datetime] = None
date_to: Optional[datetime.datetime] = None
delivery_method_id: Optional[int] = None
general_comments: Optional[str] = None
port_id: Optional[int] = None
requested_terms_type: Optional[str] = None
vessel_id: Optional[int] = None
supply_desk_entity_contact_id: Optional[int] = None
selected_entity_contact_ids: Optional[List[str]] = None
enquiry_grades: Optional[List[CreateEnquiryGradesViewModel]] = 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Enquiries/Create HTTP/1.1
Host: internal.thebunkerbridge.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<EnquiryCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bridge.Private.Api.DTO">
<AccountId>0</AccountId>
<Agent>String</Agent>
<BuyerCompany>String</BuyerCompany>
<BuyerEmailAddress>String</BuyerEmailAddress>
<CreditTermDays>0</CreditTermDays>
<DateFrom>0001-01-01T00:00:00</DateFrom>
<DateTo>0001-01-01T00:00:00</DateTo>
<DeliveryMethodId>0</DeliveryMethodId>
<EnquiryGrades xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bridge.Core.ViewModels">
<d2p1:CreateEnquiryGradesViewModel>
<d2p1:Deleted>false</d2p1:Deleted>
<d2p1:GradeId>0</d2p1:GradeId>
<d2p1:Id>0</d2p1:Id>
<d2p1:ProductId>0</d2p1:ProductId>
<d2p1:SpecificationComments>String</d2p1:SpecificationComments>
<d2p1:UnitId>0</d2p1:UnitId>
<d2p1:VersionId>0</d2p1:VersionId>
<d2p1:VolumeFrom>0</d2p1:VolumeFrom>
<d2p1:VolumeTo>0</d2p1:VolumeTo>
</d2p1:CreateEnquiryGradesViewModel>
</EnquiryGrades>
<GeneralComments>String</GeneralComments>
<PortId>0</PortId>
<RequestedTermsType>String</RequestedTermsType>
<SelectedEntityContactIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</SelectedEntityContactIds>
<SupplyDeskEntityContactId>0</SupplyDeskEntityContactId>
<VesselId>0</VesselId>
</EnquiryCreate>
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>