| POST,OPTIONS | /v1/worker/dispatch/haul |
|---|
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 DriverStampView:
stage: Optional[str] = None
at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
note: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DriverTruckView:
code: Optional[str] = None
stage: Optional[str] = None
stage_since_utc: Optional[datetime.datetime] = None
loads_today: int = 0
net_today: Decimal = decimal.Decimal(0)
est_load: Optional[Decimal] = None
slot: Optional[str] = None
site_name: Optional[str] = None
supplier_name: Optional[str] = None
next_site_name: Optional[str] = None
facility: Optional[str] = None
facility_short: Optional[str] = None
unit: Optional[str] = None
queue_position: Optional[int] = None
hold_code: Optional[str] = None
hold_reason: Optional[str] = None
hold_end_utc: Optional[datetime.datetime] = None
open_load_id: Optional[int] = None
open_load_code: Optional[str] = None
open_load_photos: int = 0
stamps: List[DriverStampView] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DriverRigView:
code: Optional[str] = None
name: Optional[str] = None
rig_type: Optional[str] = None
is_free: bool = False
hold_code: Optional[str] = None
hold_reason: Optional[str] = None
hold_end_utc: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DriverJobView:
kind: Optional[str] = None
code: Optional[str] = None
cargo: Optional[str] = None
customer: Optional[str] = None
customer_phone: Optional[str] = None
hold_contact: Optional[str] = None
hold_phone: Optional[str] = None
from_loc: Optional[str] = None
to_loc: Optional[str] = None
miles: int = 0
window_text: Optional[str] = None
stage: Optional[str] = None
rate: Optional[Decimal] = None
required_rig: Optional[str] = None
eta_text: Optional[str] = None
offer_expires_utc: Optional[datetime.datetime] = None
request_id: Optional[int] = None
load_id: Optional[int] = None
load_code: Optional[str] = None
load_pay: Optional[Decimal] = None
photos: int = 0
stamps: List[DriverStampView] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DriverOdView:
code: Optional[str] = None
name: Optional[str] = None
zone: Optional[str] = None
status: Optional[str] = None
tier: Optional[str] = None
capabilities: Optional[str] = None
ping_code: Optional[str] = None
ping_address: Optional[str] = None
ping_zone: Optional[str] = None
ping_bags: Optional[int] = None
ping_needs: Optional[str] = None
ping_note: Optional[str] = None
ping_expires_utc: Optional[datetime.datetime] = None
run_code: Optional[str] = None
run_address: Optional[str] = None
run_zone: Optional[str] = None
run_bags: Optional[int] = None
run_stage: Optional[str] = None
run_needs: Optional[str] = None
run_note: Optional[str] = None
run_eta: Optional[str] = None
od_base: Optional[Decimal] = None
od_per_bag: Optional[Decimal] = None
hold_code: Optional[str] = None
hold_reason: Optional[str] = None
hold_end_utc: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchIncidentMessageView:
message_id: int = 0
who: Optional[str] = None
role: Optional[str] = None
msg: Optional[str] = None
at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DriverIncidentView:
incident_id: int = 0
code: Optional[str] = None
kind: Optional[str] = None
kind_detail: Optional[str] = None
status: Optional[str] = None
load_code: Optional[str] = None
truck_code: Optional[str] = None
location_text: Optional[str] = None
driver_pref: Optional[str] = None
truck_recovery: Optional[str] = None
load_recovery: Optional[str] = None
transload_truck_code: Optional[str] = None
hold_code: Optional[str] = None
opened_utc: datetime.datetime = datetime.datetime(1, 1, 1)
resolved_utc: Optional[datetime.datetime] = None
messages: List[DispatchIncidentMessageView] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DriverPayLineView:
code: Optional[str] = None
module: Optional[str] = None
source_label: Optional[str] = None
destination_label: Optional[str] = None
qty_text: Optional[str] = None
pay: Optional[Decimal] = None
pay_plan_label: Optional[str] = None
status: Optional[str] = None
closed_utc: Optional[datetime.datetime] = None
opened_utc: datetime.datetime = datetime.datetime(1, 1, 1)
ticket_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DriverMeResponse:
contact_id: int = 0
name: Optional[str] = None
phone: Optional[str] = None
pay_plan_name: Optional[str] = None
pay_plan_basis: Optional[str] = None
pay_plan_rate: Optional[Decimal] = None
truck: Optional[DriverTruckView] = None
rig: Optional[DriverRigView] = None
jobs: List[DriverJobView] = field(default_factory=list)
od: Optional[DriverOdView] = None
incidents: List[DriverIncidentView] = field(default_factory=list)
pay: List[DriverPayLineView] = field(default_factory=list)
server_utc: datetime.datetime = datetime.datetime(1, 1, 1)
message: Optional[str] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DriverHaulRequest:
action: Optional[str] = None
net_tons: Optional[Decimal] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/worker/dispatch/haul HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Action":"String","NetTons":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ContactId":0,"Name":"String","Phone":"String","PayPlanName":"String","PayPlanBasis":"String","PayPlanRate":0,"Truck":{"Code":"String","Stage":"String","StageSinceUtc":"0001-01-01T00:00:00.0000000","LoadsToday":0,"NetToday":0,"EstLoad":0,"Slot":"String","SiteName":"String","SupplierName":"String","NextSiteName":"String","Facility":"String","FacilityShort":"String","Unit":"String","QueuePosition":0,"HoldCode":"String","HoldReason":"String","HoldEndUtc":"0001-01-01T00:00:00.0000000","OpenLoadId":0,"OpenLoadCode":"String","OpenLoadPhotos":0,"Stamps":[{"Stage":"String","AtUtc":"0001-01-01T00:00:00.0000000","Note":"String"}]},"Rig":{"Code":"String","Name":"String","RigType":"String","IsFree":false,"HoldCode":"String","HoldReason":"String","HoldEndUtc":"0001-01-01T00:00:00.0000000"},"Jobs":[{"Kind":"String","Code":"String","Cargo":"String","Customer":"String","CustomerPhone":"String","HoldContact":"String","HoldPhone":"String","FromLoc":"String","ToLoc":"String","Miles":0,"WindowText":"String","Stage":"String","Rate":0,"RequiredRig":"String","EtaText":"String","OfferExpiresUtc":"0001-01-01T00:00:00.0000000","RequestId":0,"LoadId":0,"LoadCode":"String","LoadPay":0,"Photos":0,"Stamps":[{"Stage":"String","AtUtc":"0001-01-01T00:00:00.0000000","Note":"String"}]}],"Od":{"Code":"String","Name":"String","Zone":"String","Status":"String","Tier":"String","Capabilities":"String","PingCode":"String","PingAddress":"String","PingZone":"String","PingBags":0,"PingNeeds":"String","PingNote":"String","PingExpiresUtc":"0001-01-01T00:00:00.0000000","RunCode":"String","RunAddress":"String","RunZone":"String","RunBags":0,"RunStage":"String","RunNeeds":"String","RunNote":"String","RunEta":"String","OdBase":0,"OdPerBag":0,"HoldCode":"String","HoldReason":"String","HoldEndUtc":"0001-01-01T00:00:00.0000000"},"Incidents":[{"IncidentId":0,"Code":"String","Kind":"String","KindDetail":"String","Status":"String","LoadCode":"String","TruckCode":"String","LocationText":"String","DriverPref":"String","TruckRecovery":"String","LoadRecovery":"String","TransloadTruckCode":"String","HoldCode":"String","OpenedUtc":"0001-01-01T00:00:00.0000000","ResolvedUtc":"0001-01-01T00:00:00.0000000","Messages":[{"MessageId":0,"Who":"String","Role":"String","Msg":"String","AtUtc":"0001-01-01T00:00:00.0000000"}]}],"Pay":[{"Code":"String","Module":"String","SourceLabel":"String","DestinationLabel":"String","QtyText":"String","Pay":0,"PayPlanLabel":"String","Status":"String","ClosedUtc":"0001-01-01T00:00:00.0000000","OpenedUtc":"0001-01-01T00:00:00.0000000","TicketCode":"String"}],"ServerUtc":"0001-01-01T00:00:00.0000000","Message":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}