Trendsic Platform Service

<back to all web services

DispatchJobQuoteRequest

export class DispatchPackConfigView
{
    public PackId: string;
    public HasQuotas: boolean;
    public IsInverted: boolean;
    public LoadLimitMins: number;
    public TicketSource: string;
    public PayBasis: string;
    public DayBoundary: string;

    public constructor(init?: Partial<DispatchPackConfigView>) { (Object as any).assign(this, init); }
}

export class DispatchHaulConfigView
{
    public QueueMax: number;
    public DumpBays: number;
    public SlotCap: number;
    public Paused: boolean;
    public FeedRate: number;

    public constructor(init?: Partial<DispatchHaulConfigView>) { (Object as any).assign(this, init); }
}

export class DispatchOfflineWindowView
{
    public OfflineWindowId: number;
    public FromHour: string;
    public ToHour: string;

    public constructor(init?: Partial<DispatchOfflineWindowView>) { (Object as any).assign(this, init); }
}

export class DispatchSiteView
{
    public SiteId: number;
    public SupplierId: number;
    public SupplierCode: string;
    public Name: string;
    public Acres: number;
    public StandingVolume: number;
    public SortOrder: number;

    public constructor(init?: Partial<DispatchSiteView>) { (Object as any).assign(this, init); }
}

export class DispatchSupplierView
{
    public SupplierId: number;
    public Code: string;
    public Name: string;
    public Region: string;
    public OwnHauler: boolean;
    public SeasonAllotment: number;
    public Delivered: number;
    public WeekCap: number;
    public WeekDelivered: number;
    public SortOrder: number;
    public Sites: DispatchSiteView[] = [];

    public constructor(init?: Partial<DispatchSupplierView>) { (Object as any).assign(this, init); }
}

export class DispatchTruckView
{
    public TruckId: number;
    public Code: string;
    public DriverName: string;
    public Phone: string;
    public EmployerCode: string;
    public SupplierCode: string;
    public SiteName: string;
    public EstLoad: number;
    public Stage: string;
    public StageSince: number;
    public CycleStart?: number;
    public StageMinsAgo: number;
    public CycleMinsAgo?: number;
    public Slot: string;
    public LoadsToday: number;
    public NetToday: number;
    public LastPingMins: number;
    public CycleMins: string;
    public IsInteractive: boolean;
    public NextSupplierCode: string;
    public NextSiteName: string;

    public constructor(init?: Partial<DispatchTruckView>) { (Object as any).assign(this, init); }
}

export class DispatchSlotView
{
    public SlotId: number;
    public Hour: string;
    public BaseBooked: number;
    public SortOrder: number;

    public constructor(init?: Partial<DispatchSlotView>) { (Object as any).assign(this, init); }
}

export class DispatchTicketView
{
    public TicketId: number;
    public Code: string;
    public TruckCode: string;
    public SupplierCode: string;
    public NetQty: number;
    public TicketedAt: string;
    public TicketedMin: number;
    public Source: string;
    public MinsAgo: number;

    public constructor(init?: Partial<DispatchTicketView>) { (Object as any).assign(this, init); }
}

export class DispatchLogView
{
    public LogId: number;
    public LoggedAt: string;
    public LoggedMin: number;
    public LogText: string;
    public Kind: string;
    public MinsAgo: number;

    public constructor(init?: Partial<DispatchLogView>) { (Object as any).assign(this, init); }
}

export class DispatchAutopilotView
{
    public IsOn: boolean;
    public RuleSlot: boolean;
    public RuleRoute: boolean;
    public RuleRelease: boolean;
    public RuleTract: boolean;
    public RuleThrottle: boolean;
    public RuleOffline: boolean;
    public ThStaged: number;
    public ThWait: number;
    public ThBand: number;
    public ThStall: number;
    public ThFeed: number;

    public constructor(init?: Partial<DispatchAutopilotView>) { (Object as any).assign(this, init); }
}

export class DispatchExceptionView
{
    public Code: string;
    public Kind: string;
    public Severity: string;
    public TruckCode: string;
    public SupplierCode: string;
    public RaisedAt: string;
    public RaisedLabel: string;
    public MinsAgo: number;

    public constructor(init?: Partial<DispatchExceptionView>) { (Object as any).assign(this, init); }
}

export class DispatchFeedView
{
    public FeedId: number;
    public EntryAt: string;
    public EntryLabel: string;
    public Channel: string;
    public Kind: string;
    public TruckCode: string;
    public SupplierCode: string;
    public OverrideText: string;
    public MinsAgo: number;

    public constructor(init?: Partial<DispatchFeedView>) { (Object as any).assign(this, init); }
}

export class DispatchRigView
{
    public RigId: number;
    public Code: string;
    public Name: string;
    public DriverName: string;
    public Phone: string;
    public RigType: string;
    public IsFree: boolean;
    public MatchRank: number;

    public constructor(init?: Partial<DispatchRigView>) { (Object as any).assign(this, init); }
}

export class DispatchJobView
{
    public JobId: number;
    public Code: string;
    public Cargo: string;
    public Customer: string;
    public CustomerPhone: string;
    public HoldContact: string;
    public HoldPhone: string;
    public FromLoc: string;
    public ToLoc: string;
    public Miles: number;
    public WindowText: string;
    public Stage: string;
    public Rate?: number;
    public RequiredRig: string;
    public DriverLabel: string;
    public EtaText: string;
    public OfferRigIds: string;
    public OfferExpiresMin?: number;
    public OfferExpired: boolean;
    public Declined: boolean;

    public constructor(init?: Partial<DispatchJobView>) { (Object as any).assign(this, init); }
}

export class DispatchOdDriverView
{
    public DriverId: number;
    public Code: string;
    public Name: string;
    public Zone: string;
    public Phone: string;
    public Status: string;
    public Tier: string;
    public DistanceMi: number;
    public Capabilities: string;

    public constructor(init?: Partial<DispatchOdDriverView>) { (Object as any).assign(this, init); }
}

export class DispatchOdRequestView
{
    public RequestId: number;
    public Code: string;
    public Address: string;
    public Zone: string;
    public Bags: number;
    public Stage: string;
    public DriverCode: string;
    public Needs: string;
    public Note: string;
    public PingExpiresMin?: number;
    public TriedCodes: string;
    public CandidateCodes: string;
    public EtaText: string;
    public NoDriver: string;

    public constructor(init?: Partial<DispatchOdRequestView>) { (Object as any).assign(this, init); }
}

export class DispatchPackView
{
    public PackId: string;
    public HasQuotas: boolean;
    public IsInverted: boolean;
    public LoadLimitMins: number;
    public DayBoundary: string;
    public TicketSource: string;
    public PayBasis: string;
    public SortOrder: number;

    public constructor(init?: Partial<DispatchPackView>) { (Object as any).assign(this, init); }
}

export class DispatchPackTermView
{
    public PackId: string;
    public Lang: string;
    public ModeName: string;
    public Facility: string;
    public FacilityShort: string;
    public SourceSite: string;
    public Supplier: string;
    public SupplierPlural: string;
    public UnloadVerb: string;
    public TicketNoun: string;
    public DayNoun: string;
    public FleetLabel: string;
    public PageSubtitle: string;
    public SeasonChip: string;
    public CampaignNoun: string;
    public BayNoun: string;
    public AssignTarget: string;

    public constructor(init?: Partial<DispatchPackTermView>) { (Object as any).assign(this, init); }
}

export class DispatchPackUnitView
{
    public PackId: string;
    public Unit: string;
    public LoadQty: number;
    public VolumeLow: number;
    public VolumeHigh: number;
    public SeasonMultiple: number;
    public WeeklyFraction: number;

    public constructor(init?: Partial<DispatchPackUnitView>) { (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<DispatchBoardView>) { (Object as any).assign(this, init); }
}

export class DispatchActionResponse
{
    public Board: DispatchBoardView;
    public Message: string;
    public Sent: number;
    public Failed: number;
    public TicketCode: string;
    public TicketNet: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DispatchActionResponse>) { (Object as any).assign(this, init); }
}

export class DispatchJobQuoteRequest
{
    public Code: string;
    public Rate: number;
    public AtMin: number;

    public constructor(init?: Partial<DispatchJobQuoteRequest>) { (Object as any).assign(this, init); }
}

TypeScript DispatchJobQuoteRequest DTOs

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

<DispatchJobQuoteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AtMin>0</AtMin>
  <Code>String</Code>
  <Rate>0</Rate>
</DispatchJobQuoteRequest>

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>