Trendsic Platform Service

DriverHaulRequest

The following routes are available for this service:
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

Python DriverHaulRequest 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.

POST /v1/worker/dispatch/haul HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DriverHaulRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Action>String</Action>
  <NetTons>0</NetTons>
</DriverHaulRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DriverMeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ContactId>0</ContactId>
  <Incidents>
    <DriverIncidentView>
      <Code>String</Code>
      <DriverPref>String</DriverPref>
      <HoldCode>String</HoldCode>
      <IncidentId>0</IncidentId>
      <Kind>String</Kind>
      <KindDetail>String</KindDetail>
      <LoadCode>String</LoadCode>
      <LoadRecovery>String</LoadRecovery>
      <LocationText>String</LocationText>
      <Messages>
        <DispatchIncidentMessageView>
          <AtUtc>0001-01-01T00:00:00</AtUtc>
          <MessageId>0</MessageId>
          <Msg>String</Msg>
          <Role>String</Role>
          <Who>String</Who>
        </DispatchIncidentMessageView>
      </Messages>
      <OpenedUtc>0001-01-01T00:00:00</OpenedUtc>
      <ResolvedUtc>0001-01-01T00:00:00</ResolvedUtc>
      <Status>String</Status>
      <TransloadTruckCode>String</TransloadTruckCode>
      <TruckCode>String</TruckCode>
      <TruckRecovery>String</TruckRecovery>
    </DriverIncidentView>
  </Incidents>
  <Jobs>
    <DriverJobView>
      <Cargo>String</Cargo>
      <Code>String</Code>
      <Customer>String</Customer>
      <CustomerPhone>String</CustomerPhone>
      <EtaText>String</EtaText>
      <FromLoc>String</FromLoc>
      <HoldContact>String</HoldContact>
      <HoldPhone>String</HoldPhone>
      <Kind>String</Kind>
      <LoadCode>String</LoadCode>
      <LoadId>0</LoadId>
      <LoadPay>0</LoadPay>
      <Miles>0</Miles>
      <OfferExpiresUtc>0001-01-01T00:00:00</OfferExpiresUtc>
      <Photos>0</Photos>
      <Rate>0</Rate>
      <RequestId>0</RequestId>
      <RequiredRig>String</RequiredRig>
      <Stage>String</Stage>
      <Stamps>
        <DriverStampView>
          <AtUtc>0001-01-01T00:00:00</AtUtc>
          <Note>String</Note>
          <Stage>String</Stage>
        </DriverStampView>
      </Stamps>
      <ToLoc>String</ToLoc>
      <WindowText>String</WindowText>
    </DriverJobView>
  </Jobs>
  <Message>String</Message>
  <Name>String</Name>
  <Od>
    <Capabilities>String</Capabilities>
    <Code>String</Code>
    <HoldCode>String</HoldCode>
    <HoldEndUtc>0001-01-01T00:00:00</HoldEndUtc>
    <HoldReason>String</HoldReason>
    <Name>String</Name>
    <OdBase>0</OdBase>
    <OdPerBag>0</OdPerBag>
    <PingAddress>String</PingAddress>
    <PingBags>0</PingBags>
    <PingCode>String</PingCode>
    <PingExpiresUtc>0001-01-01T00:00:00</PingExpiresUtc>
    <PingNeeds>String</PingNeeds>
    <PingNote>String</PingNote>
    <PingZone>String</PingZone>
    <RunAddress>String</RunAddress>
    <RunBags>0</RunBags>
    <RunCode>String</RunCode>
    <RunEta>String</RunEta>
    <RunNeeds>String</RunNeeds>
    <RunNote>String</RunNote>
    <RunStage>String</RunStage>
    <RunZone>String</RunZone>
    <Status>String</Status>
    <Tier>String</Tier>
    <Zone>String</Zone>
  </Od>
  <Pay>
    <DriverPayLineView>
      <ClosedUtc>0001-01-01T00:00:00</ClosedUtc>
      <Code>String</Code>
      <DestinationLabel>String</DestinationLabel>
      <Module>String</Module>
      <OpenedUtc>0001-01-01T00:00:00</OpenedUtc>
      <Pay>0</Pay>
      <PayPlanLabel>String</PayPlanLabel>
      <QtyText>String</QtyText>
      <SourceLabel>String</SourceLabel>
      <Status>String</Status>
      <TicketCode>String</TicketCode>
    </DriverPayLineView>
  </Pay>
  <PayPlanBasis>String</PayPlanBasis>
  <PayPlanName>String</PayPlanName>
  <PayPlanRate>0</PayPlanRate>
  <Phone>String</Phone>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Rig>
    <Code>String</Code>
    <HoldCode>String</HoldCode>
    <HoldEndUtc>0001-01-01T00:00:00</HoldEndUtc>
    <HoldReason>String</HoldReason>
    <IsFree>false</IsFree>
    <Name>String</Name>
    <RigType>String</RigType>
  </Rig>
  <ServerUtc>0001-01-01T00:00:00</ServerUtc>
  <Truck>
    <Code>String</Code>
    <EstLoad>0</EstLoad>
    <Facility>String</Facility>
    <FacilityShort>String</FacilityShort>
    <HoldCode>String</HoldCode>
    <HoldEndUtc>0001-01-01T00:00:00</HoldEndUtc>
    <HoldReason>String</HoldReason>
    <LoadsToday>0</LoadsToday>
    <NetToday>0</NetToday>
    <NextSiteName>String</NextSiteName>
    <OpenLoadCode>String</OpenLoadCode>
    <OpenLoadId>0</OpenLoadId>
    <OpenLoadPhotos>0</OpenLoadPhotos>
    <QueuePosition>0</QueuePosition>
    <SiteName>String</SiteName>
    <Slot>String</Slot>
    <Stage>String</Stage>
    <StageSinceUtc>0001-01-01T00:00:00</StageSinceUtc>
    <Stamps>
      <DriverStampView>
        <AtUtc>0001-01-01T00:00:00</AtUtc>
        <Note>String</Note>
        <Stage>String</Stage>
      </DriverStampView>
    </Stamps>
    <SupplierName>String</SupplierName>
    <Unit>String</Unit>
  </Truck>
</DriverMeResponse>