Trendsic Platform Service

DriverHaulRequest

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

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class DispatchIncidentMessageView
    {
        public virtual int MessageId { get; set; }
        public virtual string Who { get; set; }
        public virtual string Role { get; set; }
        public virtual string Msg { get; set; }
        public virtual DateTime AtUtc { get; set; }
    }

    public partial class DriverHaulRequest
    {
        public virtual string Action { get; set; }
        public virtual decimal? NetTons { get; set; }
    }

    public partial class DriverIncidentView
    {
        public virtual int IncidentId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Kind { get; set; }
        public virtual string KindDetail { get; set; }
        public virtual string Status { get; set; }
        public virtual string LoadCode { get; set; }
        public virtual string TruckCode { get; set; }
        public virtual string LocationText { get; set; }
        public virtual string DriverPref { get; set; }
        public virtual string TruckRecovery { get; set; }
        public virtual string LoadRecovery { get; set; }
        public virtual string TransloadTruckCode { get; set; }
        public virtual string HoldCode { get; set; }
        public virtual DateTime OpenedUtc { get; set; }
        public virtual DateTime? ResolvedUtc { get; set; }
        public virtual List<DispatchIncidentMessageView> Messages { get; set; } = [];
    }

    public partial class DriverJobView
    {
        public virtual string Kind { get; set; }
        public virtual string Code { get; set; }
        public virtual string Cargo { get; set; }
        public virtual string Customer { get; set; }
        public virtual string CustomerPhone { get; set; }
        public virtual string HoldContact { get; set; }
        public virtual string HoldPhone { get; set; }
        public virtual string FromLoc { get; set; }
        public virtual string ToLoc { get; set; }
        public virtual int Miles { get; set; }
        public virtual string WindowText { get; set; }
        public virtual string Stage { get; set; }
        public virtual decimal? Rate { get; set; }
        public virtual string RequiredRig { get; set; }
        public virtual string EtaText { get; set; }
        public virtual DateTime? OfferExpiresUtc { get; set; }
        public virtual int? RequestId { get; set; }
        public virtual int? LoadId { get; set; }
        public virtual string LoadCode { get; set; }
        public virtual decimal? LoadPay { get; set; }
        public virtual int Photos { get; set; }
        public virtual List<DriverStampView> Stamps { get; set; } = [];
    }

    public partial class DriverMeResponse
    {
        public virtual int ContactId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Phone { get; set; }
        public virtual string PayPlanName { get; set; }
        public virtual string PayPlanBasis { get; set; }
        public virtual decimal? PayPlanRate { get; set; }
        public virtual DriverTruckView Truck { get; set; }
        public virtual DriverRigView Rig { get; set; }
        public virtual List<DriverJobView> Jobs { get; set; } = [];
        public virtual DriverOdView Od { get; set; }
        public virtual List<DriverIncidentView> Incidents { get; set; } = [];
        public virtual List<DriverPayLineView> Pay { get; set; } = [];
        public virtual DateTime ServerUtc { get; set; }
        public virtual string Message { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class DriverOdView
    {
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string Zone { get; set; }
        public virtual string Status { get; set; }
        public virtual string Tier { get; set; }
        public virtual string Capabilities { get; set; }
        public virtual string PingCode { get; set; }
        public virtual string PingAddress { get; set; }
        public virtual string PingZone { get; set; }
        public virtual int? PingBags { get; set; }
        public virtual string PingNeeds { get; set; }
        public virtual string PingNote { get; set; }
        public virtual DateTime? PingExpiresUtc { get; set; }
        public virtual string RunCode { get; set; }
        public virtual string RunAddress { get; set; }
        public virtual string RunZone { get; set; }
        public virtual int? RunBags { get; set; }
        public virtual string RunStage { get; set; }
        public virtual string RunNeeds { get; set; }
        public virtual string RunNote { get; set; }
        public virtual string RunEta { get; set; }
        public virtual decimal? OdBase { get; set; }
        public virtual decimal? OdPerBag { get; set; }
        public virtual string HoldCode { get; set; }
        public virtual string HoldReason { get; set; }
        public virtual DateTime? HoldEndUtc { get; set; }
    }

    public partial class DriverPayLineView
    {
        public virtual string Code { get; set; }
        public virtual string Module { get; set; }
        public virtual string SourceLabel { get; set; }
        public virtual string DestinationLabel { get; set; }
        public virtual string QtyText { get; set; }
        public virtual decimal? Pay { get; set; }
        public virtual string PayPlanLabel { get; set; }
        public virtual string Status { get; set; }
        public virtual DateTime? ClosedUtc { get; set; }
        public virtual DateTime OpenedUtc { get; set; }
        public virtual string TicketCode { get; set; }
    }

    public partial class DriverRigView
    {
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string RigType { get; set; }
        public virtual bool IsFree { get; set; }
        public virtual string HoldCode { get; set; }
        public virtual string HoldReason { get; set; }
        public virtual DateTime? HoldEndUtc { get; set; }
    }

    public partial class DriverStampView
    {
        public virtual string Stage { get; set; }
        public virtual DateTime AtUtc { get; set; }
        public virtual string Note { get; set; }
    }

    public partial class DriverTruckView
    {
        public virtual string Code { get; set; }
        public virtual string Stage { get; set; }
        public virtual DateTime? StageSinceUtc { get; set; }
        public virtual int LoadsToday { get; set; }
        public virtual decimal NetToday { get; set; }
        public virtual decimal? EstLoad { get; set; }
        public virtual string Slot { get; set; }
        public virtual string SiteName { get; set; }
        public virtual string SupplierName { get; set; }
        public virtual string NextSiteName { get; set; }
        public virtual string Facility { get; set; }
        public virtual string FacilityShort { get; set; }
        public virtual string Unit { get; set; }
        public virtual int? QueuePosition { get; set; }
        public virtual string HoldCode { get; set; }
        public virtual string HoldReason { get; set; }
        public virtual DateTime? HoldEndUtc { get; set; }
        public virtual int? OpenLoadId { get; set; }
        public virtual string OpenLoadCode { get; set; }
        public virtual int OpenLoadPhotos { get; set; }
        public virtual List<DriverStampView> Stamps { get; set; } = [];
    }

}

C# 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>