| POST,OPTIONS | /v1/dispatch/requests/{RequestId}/quote |
|---|
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 DispatchRequestEventView:
event_id: int = 0
kind: Optional[str] = None
detail: Optional[str] = None
at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
by_who: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchRequestView:
request_id: int = 0
code: Optional[str] = None
customer_name: Optional[str] = None
customer_phone: Optional[str] = None
customer_email: Optional[str] = None
cargo: Optional[str] = None
units: int = 0
from_loc: Optional[str] = None
to_loc: Optional[str] = None
miles: Optional[int] = None
window_text: Optional[str] = None
is_urgent: bool = False
notes: Optional[str] = None
source: Optional[str] = None
status: Optional[str] = None
required_rig: Optional[str] = None
units_per_truck: Optional[int] = None
rate_per_load: Optional[Decimal] = None
urgency_pct: Decimal = decimal.Decimal(0)
cost_per_load: Optional[Decimal] = None
loads_needed: Optional[int] = None
quote_total: Optional[Decimal] = None
quote_version: int = 0
quoted_utc: Optional[datetime.datetime] = None
quoted_by: Optional[str] = None
accept_token_expires_utc: Optional[datetime.datetime] = None
accepted_utc: Optional[datetime.datetime] = None
accepted_via: Optional[str] = None
declined_utc: Optional[datetime.datetime] = None
declined_by: Optional[str] = None
decline_reason: Optional[str] = None
jobs_created: int = 0
jobs_done: int = 0
jobs_need_driver: int = 0
created_utc: datetime.datetime = datetime.datetime(1, 1, 1)
created_by: Optional[str] = None
events: List[DispatchRequestEventView] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchRigCountView:
rig_type: Optional[str] = None
rigs: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchCarrierPickView:
vendor_i_d: int = 0
vendor_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchRequestsResponse:
requests: List[DispatchRequestView] = field(default_factory=list)
request: Optional[DispatchRequestView] = None
rig_counts: List[DispatchRigCountView] = field(default_factory=list)
carriers: List[DispatchCarrierPickView] = field(default_factory=list)
quote_link: Optional[str] = None
delivery: Optional[str] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchRequestQuoteRequest:
request_id: int = 0
required_rig: Optional[str] = None
units_per_truck: Optional[int] = None
rate_per_load: Optional[Decimal] = None
urgency_pct: Optional[Decimal] = None
cost_per_load: Optional[Decimal] = None
Python DispatchRequestQuoteRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/dispatch/requests/{RequestId}/quote HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
RequestId: 0,
RequiredRig: String,
UnitsPerTruck: 0,
RatePerLoad: 0,
UrgencyPct: 0,
CostPerLoad: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Requests:
[
{
RequestId: 0,
Code: String,
CustomerName: String,
CustomerPhone: String,
CustomerEmail: String,
Cargo: String,
Units: 0,
FromLoc: String,
ToLoc: String,
Miles: 0,
WindowText: String,
IsUrgent: False,
Notes: String,
Source: String,
Status: String,
RequiredRig: String,
UnitsPerTruck: 0,
RatePerLoad: 0,
UrgencyPct: 0,
CostPerLoad: 0,
LoadsNeeded: 0,
QuoteTotal: 0,
QuoteVersion: 0,
QuotedUtc: 0001-01-01,
QuotedBy: String,
AcceptTokenExpiresUtc: 0001-01-01,
AcceptedUtc: 0001-01-01,
AcceptedVia: String,
DeclinedUtc: 0001-01-01,
DeclinedBy: String,
DeclineReason: String,
JobsCreated: 0,
JobsDone: 0,
JobsNeedDriver: 0,
CreatedUtc: 0001-01-01,
CreatedBy: String,
Events:
[
{
EventId: 0,
Kind: String,
Detail: String,
AtUtc: 0001-01-01,
ByWho: String
}
]
}
],
Request:
{
RequestId: 0,
Code: String,
CustomerName: String,
CustomerPhone: String,
CustomerEmail: String,
Cargo: String,
Units: 0,
FromLoc: String,
ToLoc: String,
Miles: 0,
WindowText: String,
IsUrgent: False,
Notes: String,
Source: String,
Status: String,
RequiredRig: String,
UnitsPerTruck: 0,
RatePerLoad: 0,
UrgencyPct: 0,
CostPerLoad: 0,
LoadsNeeded: 0,
QuoteTotal: 0,
QuoteVersion: 0,
QuotedUtc: 0001-01-01,
QuotedBy: String,
AcceptTokenExpiresUtc: 0001-01-01,
AcceptedUtc: 0001-01-01,
AcceptedVia: String,
DeclinedUtc: 0001-01-01,
DeclinedBy: String,
DeclineReason: String,
JobsCreated: 0,
JobsDone: 0,
JobsNeedDriver: 0,
CreatedUtc: 0001-01-01,
CreatedBy: String,
Events:
[
{
EventId: 0,
Kind: String,
Detail: String,
AtUtc: 0001-01-01,
ByWho: String
}
]
},
RigCounts:
[
{
RigType: String,
Rigs: 0
}
],
Carriers:
[
{
VendorID: 0,
VendorName: String
}
],
QuoteLink: String,
Delivery: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}