Trendsic Platform Service

<back to all web services

DispatchBoardRequest

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class DispatchBoardRequest
{
}

open class DispatchBoardResponse
{
    open var Board:DispatchBoardView? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class DispatchBoardView
{
    open var Pack:DispatchPackConfigView? = null
    open var Config:DispatchHaulConfigView? = null
    open var OfflineWindows:ArrayList<DispatchOfflineWindowView> = ArrayList<DispatchOfflineWindowView>()
    open var Suppliers:ArrayList<DispatchSupplierView> = ArrayList<DispatchSupplierView>()
    open var Trucks:ArrayList<DispatchTruckView> = ArrayList<DispatchTruckView>()
    open var Slots:ArrayList<DispatchSlotView> = ArrayList<DispatchSlotView>()
    open var Tickets:ArrayList<DispatchTicketView> = ArrayList<DispatchTicketView>()
    open var Log:ArrayList<DispatchLogView> = ArrayList<DispatchLogView>()
    open var Autopilot:DispatchAutopilotView? = null
    open var Exceptions:ArrayList<DispatchExceptionView> = ArrayList<DispatchExceptionView>()
    open var Feed:ArrayList<DispatchFeedView> = ArrayList<DispatchFeedView>()
    open var Rigs:ArrayList<DispatchRigView> = ArrayList<DispatchRigView>()
    open var Jobs:ArrayList<DispatchJobView> = ArrayList<DispatchJobView>()
    open var OdDrivers:ArrayList<DispatchOdDriverView> = ArrayList<DispatchOdDriverView>()
    open var OdRequests:ArrayList<DispatchOdRequestView> = ArrayList<DispatchOdRequestView>()
    open var Packs:ArrayList<DispatchPackView> = ArrayList<DispatchPackView>()
    open var PackTerms:ArrayList<DispatchPackTermView> = ArrayList<DispatchPackTermView>()
    open var PackUnits:ArrayList<DispatchPackUnitView> = ArrayList<DispatchPackUnitView>()
}

open class DispatchPackConfigView
{
    open var PackId:String? = null
    open var HasQuotas:Boolean? = null
    open var IsInverted:Boolean? = null
    open var LoadLimitMins:Int? = null
    open var TicketSource:String? = null
    open var PayBasis:String? = null
    open var DayBoundary:String? = null
}

open class DispatchHaulConfigView
{
    open var QueueMax:Int? = null
    open var DumpBays:Int? = null
    open var SlotCap:Int? = null
    open var Paused:Boolean? = null
    open var FeedRate:Int? = null
}

open class DispatchOfflineWindowView
{
    open var OfflineWindowId:Int? = null
    open var FromHour:String? = null
    open var ToHour:String? = null
}

open class DispatchSupplierView
{
    open var SupplierId:Int? = null
    open var Code:String? = null
    open var Name:String? = null
    open var Region:String? = null
    open var OwnHauler:Boolean? = null
    open var SeasonAllotment:BigDecimal? = null
    open var Delivered:BigDecimal? = null
    open var WeekCap:BigDecimal? = null
    open var WeekDelivered:BigDecimal? = null
    open var SortOrder:Int? = null
    open var Sites:ArrayList<DispatchSiteView> = ArrayList<DispatchSiteView>()
}

open class DispatchSiteView
{
    open var SiteId:Int? = null
    open var SupplierId:Int? = null
    open var SupplierCode:String? = null
    open var Name:String? = null
    open var Acres:Int? = null
    open var StandingVolume:BigDecimal? = null
    open var SortOrder:Int? = null
}

open class DispatchTruckView
{
    open var TruckId:Int? = null
    open var Code:String? = null
    open var DriverName:String? = null
    open var Phone:String? = null
    open var EmployerCode:String? = null
    open var SupplierCode:String? = null
    open var SiteName:String? = null
    open var EstLoad:BigDecimal? = null
    open var Stage:String? = null
    open var StageSince:Int? = null
    open var CycleStart:Int? = null
    open var StageMinsAgo:Int? = null
    open var CycleMinsAgo:Int? = null
    open var Slot:String? = null
    open var LoadsToday:Int? = null
    open var NetToday:BigDecimal? = null
    open var LastPingMins:Int? = null
    open var CycleMins:String? = null
    open var IsInteractive:Boolean? = null
    open var NextSupplierCode:String? = null
    open var NextSiteName:String? = null
}

open class DispatchSlotView
{
    open var SlotId:Int? = null
    open var Hour:String? = null
    open var BaseBooked:Int? = null
    open var SortOrder:Int? = null
}

open class DispatchTicketView
{
    open var TicketId:Int? = null
    open var Code:String? = null
    open var TruckCode:String? = null
    open var SupplierCode:String? = null
    open var NetQty:BigDecimal? = null
    open var TicketedAt:Date? = null
    open var TicketedMin:Int? = null
    open var Source:String? = null
    open var MinsAgo:Int? = null
}

open class DispatchLogView
{
    open var LogId:Int? = null
    open var LoggedAt:Date? = null
    open var LoggedMin:Int? = null
    open var LogText:String? = null
    open var Kind:String? = null
    open var MinsAgo:Int? = null
}

open class DispatchAutopilotView
{
    open var IsOn:Boolean? = null
    open var RuleSlot:Boolean? = null
    open var RuleRoute:Boolean? = null
    open var RuleRelease:Boolean? = null
    open var RuleTract:Boolean? = null
    open var RuleThrottle:Boolean? = null
    open var RuleOffline:Boolean? = null
    open var ThStaged:Int? = null
    open var ThWait:Int? = null
    open var ThBand:Int? = null
    open var ThStall:Int? = null
    open var ThFeed:Int? = null
}

open class DispatchExceptionView
{
    open var Code:String? = null
    open var Kind:String? = null
    open var Severity:String? = null
    open var TruckCode:String? = null
    open var SupplierCode:String? = null
    open var RaisedAt:Date? = null
    open var RaisedLabel:String? = null
    open var MinsAgo:Int? = null
}

open class DispatchFeedView
{
    open var FeedId:Int? = null
    open var EntryAt:Date? = null
    open var EntryLabel:String? = null
    open var Channel:String? = null
    open var Kind:String? = null
    open var TruckCode:String? = null
    open var SupplierCode:String? = null
    open var OverrideText:String? = null
    open var MinsAgo:Int? = null
}

open class DispatchRigView
{
    open var RigId:Int? = null
    open var Code:String? = null
    open var Name:String? = null
    open var DriverName:String? = null
    open var Phone:String? = null
    open var RigType:String? = null
    open var IsFree:Boolean? = null
    open var MatchRank:Int? = null
}

open class DispatchJobView
{
    open var JobId:Int? = null
    open var Code:String? = null
    open var Cargo:String? = null
    open var Customer:String? = null
    open var CustomerPhone:String? = null
    open var HoldContact:String? = null
    open var HoldPhone:String? = null
    open var FromLoc:String? = null
    open var ToLoc:String? = null
    open var Miles:Int? = null
    open var WindowText:String? = null
    open var Stage:String? = null
    open var Rate:BigDecimal? = null
    open var RequiredRig:String? = null
    open var DriverLabel:String? = null
    open var EtaText:String? = null
    open var OfferRigIds:String? = null
    open var OfferExpiresMin:Int? = null
    open var OfferExpired:Boolean? = null
    open var Declined:Boolean? = null
}

open class DispatchOdDriverView
{
    open var DriverId:Int? = null
    open var Code:String? = null
    open var Name:String? = null
    open var Zone:String? = null
    open var Phone:String? = null
    open var Status:String? = null
    open var Tier:String? = null
    open var DistanceMi:BigDecimal? = null
    open var Capabilities:String? = null
}

open class DispatchOdRequestView
{
    open var RequestId:Int? = null
    open var Code:String? = null
    open var Address:String? = null
    open var Zone:String? = null
    open var Bags:Int? = null
    open var Stage:String? = null
    open var DriverCode:String? = null
    open var Needs:String? = null
    open var Note:String? = null
    open var PingExpiresMin:Int? = null
    open var TriedCodes:String? = null
    open var CandidateCodes:String? = null
    open var EtaText:String? = null
    open var NoDriver:String? = null
}

open class DispatchPackView
{
    open var PackId:String? = null
    open var HasQuotas:Boolean? = null
    open var IsInverted:Boolean? = null
    open var LoadLimitMins:Int? = null
    open var DayBoundary:String? = null
    open var TicketSource:String? = null
    open var PayBasis:String? = null
    open var SortOrder:Int? = null
}

open class DispatchPackTermView
{
    open var PackId:String? = null
    open var Lang:String? = null
    open var ModeName:String? = null
    open var Facility:String? = null
    open var FacilityShort:String? = null
    open var SourceSite:String? = null
    open var Supplier:String? = null
    open var SupplierPlural:String? = null
    open var UnloadVerb:String? = null
    open var TicketNoun:String? = null
    open var DayNoun:String? = null
    open var FleetLabel:String? = null
    open var PageSubtitle:String? = null
    open var SeasonChip:String? = null
    open var CampaignNoun:String? = null
    open var BayNoun:String? = null
    open var AssignTarget:String? = null
}

open class DispatchPackUnitView
{
    open var PackId:String? = null
    open var Unit:String? = null
    open var LoadQty:BigDecimal? = null
    open var VolumeLow:Int? = null
    open var VolumeHigh:Int? = null
    open var SeasonMultiple:BigDecimal? = null
    open var WeeklyFraction:BigDecimal? = null
}

Kotlin DispatchBoardRequest DTOs

GET /v1/dispatch/board HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<DispatchBoardResponse 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>
  <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>
</DispatchBoardResponse>