Trendsic Platform Service

DriverHaulRequest

The following routes are available for this service:
POST,OPTIONS	/v1/worker/dispatch/haul

import Foundation
import ServiceStack

public class DriverHaulRequest : Codable
{
    public var action:String
    public var netTons:Double?

    required public init(){}
}

public class DriverMeResponse : Codable
{
    public var contactId:Int
    public var name:String
    public var phone:String
    public var payPlanName:String
    public var payPlanBasis:String
    public var payPlanRate:Double?
    public var truck:DriverTruckView
    public var rig:DriverRigView
    public var jobs:[DriverJobView] = []
    public var od:DriverOdView
    public var incidents:[DriverIncidentView] = []
    public var pay:[DriverPayLineView] = []
    public var serverUtc:Date
    public var message:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class DriverTruckView : Codable
{
    public var code:String
    public var stage:String
    public var stageSinceUtc:Date?
    public var loadsToday:Int
    public var netToday:Double
    public var estLoad:Double?
    public var slot:String
    public var siteName:String
    public var supplierName:String
    public var nextSiteName:String
    public var facility:String
    public var facilityShort:String
    public var unit:String
    public var queuePosition:Int?
    public var holdCode:String
    public var holdReason:String
    public var holdEndUtc:Date?
    public var openLoadId:Int?
    public var openLoadCode:String
    public var openLoadPhotos:Int
    public var stamps:[DriverStampView] = []

    required public init(){}
}

public class DriverStampView : Codable
{
    public var stage:String
    public var atUtc:Date
    public var note:String

    required public init(){}
}

public class DriverRigView : Codable
{
    public var code:String
    public var name:String
    public var rigType:String
    public var isFree:Bool
    public var holdCode:String
    public var holdReason:String
    public var holdEndUtc:Date?

    required public init(){}
}

public class DriverJobView : Codable
{
    public var kind:String
    public var code:String
    public var cargo:String
    public var customer:String
    public var customerPhone:String
    public var holdContact:String
    public var holdPhone:String
    public var fromLoc:String
    public var toLoc:String
    public var miles:Int
    public var windowText:String
    public var stage:String
    public var rate:Double?
    public var requiredRig:String
    public var etaText:String
    public var offerExpiresUtc:Date?
    public var requestId:Int?
    public var loadId:Int?
    public var loadCode:String
    public var loadPay:Double?
    public var photos:Int
    public var stamps:[DriverStampView] = []

    required public init(){}
}

public class DriverOdView : Codable
{
    public var code:String
    public var name:String
    public var zone:String
    public var status:String
    public var tier:String
    public var capabilities:String
    public var pingCode:String
    public var pingAddress:String
    public var pingZone:String
    public var pingBags:Int?
    public var pingNeeds:String
    public var pingNote:String
    public var pingExpiresUtc:Date?
    public var runCode:String
    public var runAddress:String
    public var runZone:String
    public var runBags:Int?
    public var runStage:String
    public var runNeeds:String
    public var runNote:String
    public var runEta:String
    public var odBase:Double?
    public var odPerBag:Double?
    public var holdCode:String
    public var holdReason:String
    public var holdEndUtc:Date?

    required public init(){}
}

public class DriverIncidentView : Codable
{
    public var incidentId:Int
    public var code:String
    public var kind:String
    public var kindDetail:String
    public var status:String
    public var loadCode:String
    public var truckCode:String
    public var locationText:String
    public var driverPref:String
    public var truckRecovery:String
    public var loadRecovery:String
    public var transloadTruckCode:String
    public var holdCode:String
    public var openedUtc:Date
    public var resolvedUtc:Date?
    public var messages:[DispatchIncidentMessageView] = []

    required public init(){}
}

public class DispatchIncidentMessageView : Codable
{
    public var messageId:Int
    public var who:String
    public var role:String
    public var msg:String
    public var atUtc:Date

    required public init(){}
}

public class DriverPayLineView : Codable
{
    public var code:String
    public var module:String
    public var sourceLabel:String
    public var destinationLabel:String
    public var qtyText:String
    public var pay:Double?
    public var payPlanLabel:String
    public var status:String
    public var closedUtc:Date?
    public var openedUtc:Date
    public var ticketCode:String

    required public init(){}
}

Swift 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>