Trendsic Platform Service

<back to all web services

DispatchJobAdvanceRequest

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 DispatchActionResponse
    {
        public virtual DispatchBoardView Board { get; set; }
        public virtual string Message { get; set; }
        public virtual int Sent { get; set; }
        public virtual int Failed { get; set; }
        public virtual string TicketCode { get; set; }
        public virtual decimal TicketNet { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class DispatchAutopilotView
    {
        public virtual bool IsOn { get; set; }
        public virtual bool RuleSlot { get; set; }
        public virtual bool RuleRoute { get; set; }
        public virtual bool RuleRelease { get; set; }
        public virtual bool RuleTract { get; set; }
        public virtual bool RuleThrottle { get; set; }
        public virtual bool RuleOffline { get; set; }
        public virtual int ThStaged { get; set; }
        public virtual int ThWait { get; set; }
        public virtual int ThBand { get; set; }
        public virtual int ThStall { get; set; }
        public virtual int ThFeed { get; set; }
    }

    public partial class DispatchBoardView
    {
        public virtual DispatchPackConfigView Pack { get; set; }
        public virtual DispatchHaulConfigView Config { get; set; }
        public virtual List<DispatchOfflineWindowView> OfflineWindows { get; set; } = [];
        public virtual List<DispatchSupplierView> Suppliers { get; set; } = [];
        public virtual List<DispatchTruckView> Trucks { get; set; } = [];
        public virtual List<DispatchSlotView> Slots { get; set; } = [];
        public virtual List<DispatchTicketView> Tickets { get; set; } = [];
        public virtual List<DispatchLogView> Log { get; set; } = [];
        public virtual DispatchAutopilotView Autopilot { get; set; }
        public virtual List<DispatchExceptionView> Exceptions { get; set; } = [];
        public virtual List<DispatchFeedView> Feed { get; set; } = [];
        public virtual List<DispatchRigView> Rigs { get; set; } = [];
        public virtual List<DispatchJobView> Jobs { get; set; } = [];
        public virtual List<DispatchOdDriverView> OdDrivers { get; set; } = [];
        public virtual List<DispatchOdRequestView> OdRequests { get; set; } = [];
        public virtual List<DispatchPackView> Packs { get; set; } = [];
        public virtual List<DispatchPackTermView> PackTerms { get; set; } = [];
        public virtual List<DispatchPackUnitView> PackUnits { get; set; } = [];
    }

    public partial class DispatchExceptionView
    {
        public virtual string Code { get; set; }
        public virtual string Kind { get; set; }
        public virtual string Severity { get; set; }
        public virtual string TruckCode { get; set; }
        public virtual string SupplierCode { get; set; }
        public virtual DateTime RaisedAt { get; set; }
        public virtual string RaisedLabel { get; set; }
        public virtual int MinsAgo { get; set; }
    }

    public partial class DispatchFeedView
    {
        public virtual int FeedId { get; set; }
        public virtual DateTime EntryAt { get; set; }
        public virtual string EntryLabel { get; set; }
        public virtual string Channel { get; set; }
        public virtual string Kind { get; set; }
        public virtual string TruckCode { get; set; }
        public virtual string SupplierCode { get; set; }
        public virtual string OverrideText { get; set; }
        public virtual int MinsAgo { get; set; }
    }

    public partial class DispatchHaulConfigView
    {
        public virtual int QueueMax { get; set; }
        public virtual int DumpBays { get; set; }
        public virtual int SlotCap { get; set; }
        public virtual bool Paused { get; set; }
        public virtual int FeedRate { get; set; }
    }

    public partial class DispatchJobAdvanceRequest
    {
        public virtual string Code { get; set; }
        public virtual string ToStage { get; set; }
        public virtual string DriverLabel { get; set; }
        public virtual string EtaText { get; set; }
        public virtual string TakeRigCode { get; set; }
        public virtual string FreeRigCode { get; set; }
        public virtual bool? Declined { get; set; }
        public virtual bool? OfferExpired { get; set; }
        public virtual bool ClearOffer { get; set; }
        public virtual string Note { get; set; }
        public virtual int AtMin { get; set; }
    }

    public partial class DispatchJobView
    {
        public virtual int JobId { 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 DriverLabel { get; set; }
        public virtual string EtaText { get; set; }
        public virtual string OfferRigIds { get; set; }
        public virtual int? OfferExpiresMin { get; set; }
        public virtual bool OfferExpired { get; set; }
        public virtual bool Declined { get; set; }
    }

    public partial class DispatchLogView
    {
        public virtual int LogId { get; set; }
        public virtual DateTime LoggedAt { get; set; }
        public virtual int LoggedMin { get; set; }
        public virtual string LogText { get; set; }
        public virtual string Kind { get; set; }
        public virtual int MinsAgo { get; set; }
    }

    public partial class DispatchOdDriverView
    {
        public virtual int DriverId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string Zone { get; set; }
        public virtual string Phone { get; set; }
        public virtual string Status { get; set; }
        public virtual string Tier { get; set; }
        public virtual decimal DistanceMi { get; set; }
        public virtual string Capabilities { get; set; }
    }

    public partial class DispatchOdRequestView
    {
        public virtual int RequestId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Address { get; set; }
        public virtual string Zone { get; set; }
        public virtual int Bags { get; set; }
        public virtual string Stage { get; set; }
        public virtual string DriverCode { get; set; }
        public virtual string Needs { get; set; }
        public virtual string Note { get; set; }
        public virtual int? PingExpiresMin { get; set; }
        public virtual string TriedCodes { get; set; }
        public virtual string CandidateCodes { get; set; }
        public virtual string EtaText { get; set; }
        public virtual string NoDriver { get; set; }
    }

    public partial class DispatchOfflineWindowView
    {
        public virtual int OfflineWindowId { get; set; }
        public virtual string FromHour { get; set; }
        public virtual string ToHour { get; set; }
    }

    public partial class DispatchPackConfigView
    {
        public virtual string PackId { get; set; }
        public virtual bool HasQuotas { get; set; }
        public virtual bool IsInverted { get; set; }
        public virtual int LoadLimitMins { get; set; }
        public virtual string TicketSource { get; set; }
        public virtual string PayBasis { get; set; }
        public virtual string DayBoundary { get; set; }
    }

    public partial class DispatchPackTermView
    {
        public virtual string PackId { get; set; }
        public virtual string Lang { get; set; }
        public virtual string ModeName { get; set; }
        public virtual string Facility { get; set; }
        public virtual string FacilityShort { get; set; }
        public virtual string SourceSite { get; set; }
        public virtual string Supplier { get; set; }
        public virtual string SupplierPlural { get; set; }
        public virtual string UnloadVerb { get; set; }
        public virtual string TicketNoun { get; set; }
        public virtual string DayNoun { get; set; }
        public virtual string FleetLabel { get; set; }
        public virtual string PageSubtitle { get; set; }
        public virtual string SeasonChip { get; set; }
        public virtual string CampaignNoun { get; set; }
        public virtual string BayNoun { get; set; }
        public virtual string AssignTarget { get; set; }
    }

    public partial class DispatchPackUnitView
    {
        public virtual string PackId { get; set; }
        public virtual string Unit { get; set; }
        public virtual decimal LoadQty { get; set; }
        public virtual int VolumeLow { get; set; }
        public virtual int VolumeHigh { get; set; }
        public virtual decimal SeasonMultiple { get; set; }
        public virtual decimal WeeklyFraction { get; set; }
    }

    public partial class DispatchPackView
    {
        public virtual string PackId { get; set; }
        public virtual bool HasQuotas { get; set; }
        public virtual bool IsInverted { get; set; }
        public virtual int LoadLimitMins { get; set; }
        public virtual string DayBoundary { get; set; }
        public virtual string TicketSource { get; set; }
        public virtual string PayBasis { get; set; }
        public virtual int SortOrder { get; set; }
    }

    public partial class DispatchRigView
    {
        public virtual int RigId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string DriverName { get; set; }
        public virtual string Phone { get; set; }
        public virtual string RigType { get; set; }
        public virtual bool IsFree { get; set; }
        public virtual int MatchRank { get; set; }
    }

    public partial class DispatchSiteView
    {
        public virtual int SiteId { get; set; }
        public virtual int SupplierId { get; set; }
        public virtual string SupplierCode { get; set; }
        public virtual string Name { get; set; }
        public virtual int Acres { get; set; }
        public virtual decimal StandingVolume { get; set; }
        public virtual int SortOrder { get; set; }
    }

    public partial class DispatchSlotView
    {
        public virtual int SlotId { get; set; }
        public virtual string Hour { get; set; }
        public virtual int BaseBooked { get; set; }
        public virtual int SortOrder { get; set; }
    }

    public partial class DispatchSupplierView
    {
        public virtual int SupplierId { get; set; }
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string Region { get; set; }
        public virtual bool OwnHauler { get; set; }
        public virtual decimal SeasonAllotment { get; set; }
        public virtual decimal Delivered { get; set; }
        public virtual decimal WeekCap { get; set; }
        public virtual decimal WeekDelivered { get; set; }
        public virtual int SortOrder { get; set; }
        public virtual List<DispatchSiteView> Sites { get; set; } = [];
    }

    public partial class DispatchTicketView
    {
        public virtual int TicketId { get; set; }
        public virtual string Code { get; set; }
        public virtual string TruckCode { get; set; }
        public virtual string SupplierCode { get; set; }
        public virtual decimal NetQty { get; set; }
        public virtual DateTime TicketedAt { get; set; }
        public virtual int TicketedMin { get; set; }
        public virtual string Source { get; set; }
        public virtual int MinsAgo { get; set; }
    }

    public partial class DispatchTruckView
    {
        public virtual int TruckId { get; set; }
        public virtual string Code { get; set; }
        public virtual string DriverName { get; set; }
        public virtual string Phone { get; set; }
        public virtual string EmployerCode { get; set; }
        public virtual string SupplierCode { get; set; }
        public virtual string SiteName { get; set; }
        public virtual decimal EstLoad { get; set; }
        public virtual string Stage { get; set; }
        public virtual int StageSince { get; set; }
        public virtual int? CycleStart { get; set; }
        public virtual int StageMinsAgo { get; set; }
        public virtual int? CycleMinsAgo { get; set; }
        public virtual string Slot { get; set; }
        public virtual int LoadsToday { get; set; }
        public virtual decimal NetToday { get; set; }
        public virtual int LastPingMins { get; set; }
        public virtual string CycleMins { get; set; }
        public virtual bool IsInteractive { get; set; }
        public virtual string NextSupplierCode { get; set; }
        public virtual string NextSiteName { get; set; }
    }

}

C# DispatchJobAdvanceRequest DTOs

POST /v1/dispatch/jobs/{Code}/advance HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchJobAdvanceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AtMin>0</AtMin>
  <ClearOffer>false</ClearOffer>
  <Code>String</Code>
  <Declined>false</Declined>
  <DriverLabel>String</DriverLabel>
  <EtaText>String</EtaText>
  <FreeRigCode>String</FreeRigCode>
  <Note>String</Note>
  <OfferExpired>false</OfferExpired>
  <TakeRigCode>String</TakeRigCode>
  <ToStage>String</ToStage>
</DispatchJobAdvanceRequest>

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

<DispatchActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Board>
    <Autopilot>
      <IsOn>false</IsOn>
      <RuleOffline>false</RuleOffline>
      <RuleRelease>false</RuleRelease>
      <RuleRoute>false</RuleRoute>
      <RuleSlot>false</RuleSlot>
      <RuleThrottle>false</RuleThrottle>
      <RuleTract>false</RuleTract>
      <ThBand>0</ThBand>
      <ThFeed>0</ThFeed>
      <ThStaged>0</ThStaged>
      <ThStall>0</ThStall>
      <ThWait>0</ThWait>
    </Autopilot>
    <Config>
      <DumpBays>0</DumpBays>
      <FeedRate>0</FeedRate>
      <Paused>false</Paused>
      <QueueMax>0</QueueMax>
      <SlotCap>0</SlotCap>
    </Config>
    <Exceptions>
      <DispatchExceptionView>
        <Code>String</Code>
        <Kind>String</Kind>
        <MinsAgo>0</MinsAgo>
        <RaisedAt>0001-01-01T00:00:00</RaisedAt>
        <RaisedLabel>String</RaisedLabel>
        <Severity>String</Severity>
        <SupplierCode>String</SupplierCode>
        <TruckCode>String</TruckCode>
      </DispatchExceptionView>
    </Exceptions>
    <Feed>
      <DispatchFeedView>
        <Channel>String</Channel>
        <EntryAt>0001-01-01T00:00:00</EntryAt>
        <EntryLabel>String</EntryLabel>
        <FeedId>0</FeedId>
        <Kind>String</Kind>
        <MinsAgo>0</MinsAgo>
        <OverrideText>String</OverrideText>
        <SupplierCode>String</SupplierCode>
        <TruckCode>String</TruckCode>
      </DispatchFeedView>
    </Feed>
    <Jobs>
      <DispatchJobView>
        <Cargo>String</Cargo>
        <Code>String</Code>
        <Customer>String</Customer>
        <CustomerPhone>String</CustomerPhone>
        <Declined>false</Declined>
        <DriverLabel>String</DriverLabel>
        <EtaText>String</EtaText>
        <FromLoc>String</FromLoc>
        <HoldContact>String</HoldContact>
        <HoldPhone>String</HoldPhone>
        <JobId>0</JobId>
        <Miles>0</Miles>
        <OfferExpired>false</OfferExpired>
        <OfferExpiresMin>0</OfferExpiresMin>
        <OfferRigIds>String</OfferRigIds>
        <Rate>0</Rate>
        <RequiredRig>String</RequiredRig>
        <Stage>String</Stage>
        <ToLoc>String</ToLoc>
        <WindowText>String</WindowText>
      </DispatchJobView>
    </Jobs>
    <Log>
      <DispatchLogView>
        <Kind>String</Kind>
        <LogId>0</LogId>
        <LogText>String</LogText>
        <LoggedAt>0001-01-01T00:00:00</LoggedAt>
        <LoggedMin>0</LoggedMin>
        <MinsAgo>0</MinsAgo>
      </DispatchLogView>
    </Log>
    <OdDrivers>
      <DispatchOdDriverView>
        <Capabilities>String</Capabilities>
        <Code>String</Code>
        <DistanceMi>0</DistanceMi>
        <DriverId>0</DriverId>
        <Name>String</Name>
        <Phone>String</Phone>
        <Status>String</Status>
        <Tier>String</Tier>
        <Zone>String</Zone>
      </DispatchOdDriverView>
    </OdDrivers>
    <OdRequests>
      <DispatchOdRequestView>
        <Address>String</Address>
        <Bags>0</Bags>
        <CandidateCodes>String</CandidateCodes>
        <Code>String</Code>
        <DriverCode>String</DriverCode>
        <EtaText>String</EtaText>
        <Needs>String</Needs>
        <NoDriver>String</NoDriver>
        <Note>String</Note>
        <PingExpiresMin>0</PingExpiresMin>
        <RequestId>0</RequestId>
        <Stage>String</Stage>
        <TriedCodes>String</TriedCodes>
        <Zone>String</Zone>
      </DispatchOdRequestView>
    </OdRequests>
    <OfflineWindows>
      <DispatchOfflineWindowView>
        <FromHour>String</FromHour>
        <OfflineWindowId>0</OfflineWindowId>
        <ToHour>String</ToHour>
      </DispatchOfflineWindowView>
    </OfflineWindows>
    <Pack>
      <DayBoundary>String</DayBoundary>
      <HasQuotas>false</HasQuotas>
      <IsInverted>false</IsInverted>
      <LoadLimitMins>0</LoadLimitMins>
      <PackId>String</PackId>
      <PayBasis>String</PayBasis>
      <TicketSource>String</TicketSource>
    </Pack>
    <PackTerms>
      <DispatchPackTermView>
        <AssignTarget>String</AssignTarget>
        <BayNoun>String</BayNoun>
        <CampaignNoun>String</CampaignNoun>
        <DayNoun>String</DayNoun>
        <Facility>String</Facility>
        <FacilityShort>String</FacilityShort>
        <FleetLabel>String</FleetLabel>
        <Lang>String</Lang>
        <ModeName>String</ModeName>
        <PackId>String</PackId>
        <PageSubtitle>String</PageSubtitle>
        <SeasonChip>String</SeasonChip>
        <SourceSite>String</SourceSite>
        <Supplier>String</Supplier>
        <SupplierPlural>String</SupplierPlural>
        <TicketNoun>String</TicketNoun>
        <UnloadVerb>String</UnloadVerb>
      </DispatchPackTermView>
    </PackTerms>
    <PackUnits>
      <DispatchPackUnitView>
        <LoadQty>0</LoadQty>
        <PackId>String</PackId>
        <SeasonMultiple>0</SeasonMultiple>
        <Unit>String</Unit>
        <VolumeHigh>0</VolumeHigh>
        <VolumeLow>0</VolumeLow>
        <WeeklyFraction>0</WeeklyFraction>
      </DispatchPackUnitView>
    </PackUnits>
    <Packs>
      <DispatchPackView>
        <DayBoundary>String</DayBoundary>
        <HasQuotas>false</HasQuotas>
        <IsInverted>false</IsInverted>
        <LoadLimitMins>0</LoadLimitMins>
        <PackId>String</PackId>
        <PayBasis>String</PayBasis>
        <SortOrder>0</SortOrder>
        <TicketSource>String</TicketSource>
      </DispatchPackView>
    </Packs>
    <Rigs>
      <DispatchRigView>
        <Code>String</Code>
        <DriverName>String</DriverName>
        <IsFree>false</IsFree>
        <MatchRank>0</MatchRank>
        <Name>String</Name>
        <Phone>String</Phone>
        <RigId>0</RigId>
        <RigType>String</RigType>
      </DispatchRigView>
    </Rigs>
    <Slots>
      <DispatchSlotView>
        <BaseBooked>0</BaseBooked>
        <Hour>String</Hour>
        <SlotId>0</SlotId>
        <SortOrder>0</SortOrder>
      </DispatchSlotView>
    </Slots>
    <Suppliers>
      <DispatchSupplierView>
        <Code>String</Code>
        <Delivered>0</Delivered>
        <Name>String</Name>
        <OwnHauler>false</OwnHauler>
        <Region>String</Region>
        <SeasonAllotment>0</SeasonAllotment>
        <Sites>
          <DispatchSiteView>
            <Acres>0</Acres>
            <Name>String</Name>
            <SiteId>0</SiteId>
            <SortOrder>0</SortOrder>
            <StandingVolume>0</StandingVolume>
            <SupplierCode>String</SupplierCode>
            <SupplierId>0</SupplierId>
          </DispatchSiteView>
        </Sites>
        <SortOrder>0</SortOrder>
        <SupplierId>0</SupplierId>
        <WeekCap>0</WeekCap>
        <WeekDelivered>0</WeekDelivered>
      </DispatchSupplierView>
    </Suppliers>
    <Tickets>
      <DispatchTicketView>
        <Code>String</Code>
        <MinsAgo>0</MinsAgo>
        <NetQty>0</NetQty>
        <Source>String</Source>
        <SupplierCode>String</SupplierCode>
        <TicketId>0</TicketId>
        <TicketedAt>0001-01-01T00:00:00</TicketedAt>
        <TicketedMin>0</TicketedMin>
        <TruckCode>String</TruckCode>
      </DispatchTicketView>
    </Tickets>
    <Trucks>
      <DispatchTruckView>
        <Code>String</Code>
        <CycleMins>String</CycleMins>
        <CycleMinsAgo>0</CycleMinsAgo>
        <CycleStart>0</CycleStart>
        <DriverName>String</DriverName>
        <EmployerCode>String</EmployerCode>
        <EstLoad>0</EstLoad>
        <IsInteractive>false</IsInteractive>
        <LastPingMins>0</LastPingMins>
        <LoadsToday>0</LoadsToday>
        <NetToday>0</NetToday>
        <NextSiteName>String</NextSiteName>
        <NextSupplierCode>String</NextSupplierCode>
        <Phone>String</Phone>
        <SiteName>String</SiteName>
        <Slot>String</Slot>
        <Stage>String</Stage>
        <StageMinsAgo>0</StageMinsAgo>
        <StageSince>0</StageSince>
        <SupplierCode>String</SupplierCode>
        <TruckId>0</TruckId>
      </DispatchTruckView>
    </Trucks>
  </Board>
  <Failed>0</Failed>
  <Message>String</Message>
  <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>
  <Sent>0</Sent>
  <TicketCode>String</TicketCode>
  <TicketNet>0</TicketNet>
</DispatchActionResponse>