| PUT,PATCH,OPTIONS | /v1/dispatch/haul/config |
|---|
"use strict";
export class DispatchPackConfigView {
/** @param {{PackId?:string,HasQuotas?:boolean,IsInverted?:boolean,LoadLimitMins?:number,TicketSource?:string,PayBasis?:string,DayBoundary?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PackId;
/** @type {boolean} */
HasQuotas;
/** @type {boolean} */
IsInverted;
/** @type {number} */
LoadLimitMins;
/** @type {string} */
TicketSource;
/** @type {string} */
PayBasis;
/** @type {string} */
DayBoundary;
}
export class DispatchHaulConfigView {
/** @param {{QueueMax?:number,DumpBays?:number,SlotCap?:number,Paused?:boolean,FeedRate?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
QueueMax;
/** @type {number} */
DumpBays;
/** @type {number} */
SlotCap;
/** @type {boolean} */
Paused;
/** @type {number} */
FeedRate;
}
export class DispatchOfflineWindowView {
/** @param {{OfflineWindowId?:number,FromHour?:string,ToHour?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
OfflineWindowId;
/** @type {string} */
FromHour;
/** @type {string} */
ToHour;
}
export class DispatchSiteView {
/** @param {{SiteId?:number,SupplierId?:number,SupplierCode?:string,Name?:string,Acres?:number,StandingVolume?:number,SortOrder?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
SiteId;
/** @type {number} */
SupplierId;
/** @type {string} */
SupplierCode;
/** @type {string} */
Name;
/** @type {number} */
Acres;
/** @type {number} */
StandingVolume;
/** @type {number} */
SortOrder;
}
export class DispatchSupplierView {
/** @param {{SupplierId?:number,Code?:string,Name?:string,Region?:string,OwnHauler?:boolean,SeasonAllotment?:number,Delivered?:number,WeekCap?:number,WeekDelivered?:number,SortOrder?:number,Sites?:DispatchSiteView[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
SupplierId;
/** @type {string} */
Code;
/** @type {string} */
Name;
/** @type {string} */
Region;
/** @type {boolean} */
OwnHauler;
/** @type {number} */
SeasonAllotment;
/** @type {number} */
Delivered;
/** @type {number} */
WeekCap;
/** @type {number} */
WeekDelivered;
/** @type {number} */
SortOrder;
/** @type {DispatchSiteView[]} */
Sites = [];
}
export class DispatchTruckView {
/** @param {{TruckId?:number,Code?:string,DriverName?:string,Phone?:string,DispatchState?:string,DispatchReason?:string,EmployerCode?:string,SupplierCode?:string,SiteName?:string,EstLoad?:number,Stage?:string,StageSince?:number,CycleStart?:number,StageMinsAgo?:number,CycleMinsAgo?:number,Slot?:string,LoadsToday?:number,NetToday?:number,LastPingMins?:number,CycleMins?:string,IsInteractive?:boolean,NextSupplierCode?:string,NextSiteName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
TruckId;
/** @type {string} */
Code;
/** @type {string} */
DriverName;
/** @type {string} */
Phone;
/** @type {string} */
DispatchState;
/** @type {string} */
DispatchReason;
/** @type {string} */
EmployerCode;
/** @type {string} */
SupplierCode;
/** @type {string} */
SiteName;
/** @type {number} */
EstLoad;
/** @type {string} */
Stage;
/** @type {number} */
StageSince;
/** @type {?number} */
CycleStart;
/** @type {number} */
StageMinsAgo;
/** @type {?number} */
CycleMinsAgo;
/** @type {string} */
Slot;
/** @type {number} */
LoadsToday;
/** @type {number} */
NetToday;
/** @type {number} */
LastPingMins;
/** @type {string} */
CycleMins;
/** @type {boolean} */
IsInteractive;
/** @type {string} */
NextSupplierCode;
/** @type {string} */
NextSiteName;
}
export class DispatchSlotView {
/** @param {{SlotId?:number,Hour?:string,BaseBooked?:number,SortOrder?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
SlotId;
/** @type {string} */
Hour;
/** @type {number} */
BaseBooked;
/** @type {number} */
SortOrder;
}
export class DispatchTicketView {
/** @param {{TicketId?:number,Code?:string,TruckCode?:string,SupplierCode?:string,NetQty?:number,TicketedAt?:string,TicketedMin?:number,Source?:string,MinsAgo?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
TicketId;
/** @type {string} */
Code;
/** @type {string} */
TruckCode;
/** @type {string} */
SupplierCode;
/** @type {number} */
NetQty;
/** @type {string} */
TicketedAt;
/** @type {number} */
TicketedMin;
/** @type {string} */
Source;
/** @type {number} */
MinsAgo;
}
export class DispatchLogView {
/** @param {{LogId?:number,LoggedAt?:string,LoggedMin?:number,LogText?:string,Kind?:string,MinsAgo?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
LogId;
/** @type {string} */
LoggedAt;
/** @type {number} */
LoggedMin;
/** @type {string} */
LogText;
/** @type {string} */
Kind;
/** @type {number} */
MinsAgo;
}
export class DispatchAutopilotView {
/** @param {{IsOn?:boolean,RuleSlot?:boolean,RuleRoute?:boolean,RuleRelease?:boolean,RuleTract?:boolean,RuleThrottle?:boolean,RuleOffline?:boolean,ThStaged?:number,ThWait?:number,ThBand?:number,ThStall?:number,ThFeed?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
IsOn;
/** @type {boolean} */
RuleSlot;
/** @type {boolean} */
RuleRoute;
/** @type {boolean} */
RuleRelease;
/** @type {boolean} */
RuleTract;
/** @type {boolean} */
RuleThrottle;
/** @type {boolean} */
RuleOffline;
/** @type {number} */
ThStaged;
/** @type {number} */
ThWait;
/** @type {number} */
ThBand;
/** @type {number} */
ThStall;
/** @type {number} */
ThFeed;
}
export class DispatchExceptionView {
/** @param {{Code?:string,Kind?:string,Severity?:string,TruckCode?:string,SupplierCode?:string,RaisedAt?:string,RaisedLabel?:string,MinsAgo?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Code;
/** @type {string} */
Kind;
/** @type {string} */
Severity;
/** @type {string} */
TruckCode;
/** @type {string} */
SupplierCode;
/** @type {string} */
RaisedAt;
/** @type {string} */
RaisedLabel;
/** @type {number} */
MinsAgo;
}
export class DispatchFeedView {
/** @param {{FeedId?:number,EntryAt?:string,EntryLabel?:string,Channel?:string,Kind?:string,TruckCode?:string,SupplierCode?:string,OverrideText?:string,MinsAgo?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
FeedId;
/** @type {string} */
EntryAt;
/** @type {string} */
EntryLabel;
/** @type {string} */
Channel;
/** @type {string} */
Kind;
/** @type {string} */
TruckCode;
/** @type {string} */
SupplierCode;
/** @type {string} */
OverrideText;
/** @type {number} */
MinsAgo;
}
export class DispatchRigView {
/** @param {{RigId?:number,Code?:string,Name?:string,DriverName?:string,Phone?:string,RigType?:string,IsFree?:boolean,MatchRank?:number,DispatchState?:string,DispatchReason?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
RigId;
/** @type {string} */
Code;
/** @type {string} */
Name;
/** @type {string} */
DriverName;
/** @type {string} */
Phone;
/** @type {string} */
RigType;
/** @type {boolean} */
IsFree;
/** @type {number} */
MatchRank;
/** @type {string} */
DispatchState;
/** @type {string} */
DispatchReason;
}
export class DispatchJobView {
/** @param {{JobId?:number,Code?:string,Cargo?:string,Customer?:string,CustomerPhone?:string,HoldContact?:string,HoldPhone?:string,FromLoc?:string,ToLoc?:string,Miles?:number,WindowText?:string,Stage?:string,Rate?:number,RequiredRig?:string,DriverLabel?:string,EtaText?:string,OfferRigIds?:string,OfferExpiresMin?:number,OfferExpiresInMins?:number,OfferExpired?:boolean,Declined?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
JobId;
/** @type {string} */
Code;
/** @type {string} */
Cargo;
/** @type {string} */
Customer;
/** @type {string} */
CustomerPhone;
/** @type {string} */
HoldContact;
/** @type {string} */
HoldPhone;
/** @type {string} */
FromLoc;
/** @type {string} */
ToLoc;
/** @type {number} */
Miles;
/** @type {string} */
WindowText;
/** @type {string} */
Stage;
/** @type {?number} */
Rate;
/** @type {string} */
RequiredRig;
/** @type {string} */
DriverLabel;
/** @type {string} */
EtaText;
/** @type {string} */
OfferRigIds;
/** @type {?number} */
OfferExpiresMin;
/** @type {?number} */
OfferExpiresInMins;
/** @type {boolean} */
OfferExpired;
/** @type {boolean} */
Declined;
}
export class DispatchOdDriverView {
/** @param {{DriverId?:number,Code?:string,Name?:string,Zone?:string,Phone?:string,Status?:string,Tier?:string,DistanceMi?:number,Capabilities?:string,DispatchState?:string,DispatchReason?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
DriverId;
/** @type {string} */
Code;
/** @type {string} */
Name;
/** @type {string} */
Zone;
/** @type {string} */
Phone;
/** @type {string} */
Status;
/** @type {string} */
Tier;
/** @type {number} */
DistanceMi;
/** @type {string} */
Capabilities;
/** @type {string} */
DispatchState;
/** @type {string} */
DispatchReason;
}
export class DispatchOdRequestView {
/** @param {{RequestId?:number,Code?:string,Address?:string,Zone?:string,Bags?:number,Stage?:string,DriverCode?:string,Needs?:string,Note?:string,PingExpiresMin?:number,PingExpiresInMins?:number,TriedCodes?:string,CandidateCodes?:string,EtaText?:string,NoDriver?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
RequestId;
/** @type {string} */
Code;
/** @type {string} */
Address;
/** @type {string} */
Zone;
/** @type {number} */
Bags;
/** @type {string} */
Stage;
/** @type {string} */
DriverCode;
/** @type {string} */
Needs;
/** @type {string} */
Note;
/** @type {?number} */
PingExpiresMin;
/** @type {?number} */
PingExpiresInMins;
/** @type {string} */
TriedCodes;
/** @type {string} */
CandidateCodes;
/** @type {string} */
EtaText;
/** @type {string} */
NoDriver;
}
export class DispatchPackView {
/** @param {{PackId?:string,HasQuotas?:boolean,IsInverted?:boolean,LoadLimitMins?:number,DayBoundary?:string,TicketSource?:string,PayBasis?:string,SortOrder?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PackId;
/** @type {boolean} */
HasQuotas;
/** @type {boolean} */
IsInverted;
/** @type {number} */
LoadLimitMins;
/** @type {string} */
DayBoundary;
/** @type {string} */
TicketSource;
/** @type {string} */
PayBasis;
/** @type {number} */
SortOrder;
}
export class DispatchPackTermView {
/** @param {{PackId?:string,Lang?:string,ModeName?:string,Facility?:string,FacilityShort?:string,SourceSite?:string,Supplier?:string,SupplierPlural?:string,UnloadVerb?:string,TicketNoun?:string,DayNoun?:string,FleetLabel?:string,PageSubtitle?:string,SeasonChip?:string,CampaignNoun?:string,BayNoun?:string,AssignTarget?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PackId;
/** @type {string} */
Lang;
/** @type {string} */
ModeName;
/** @type {string} */
Facility;
/** @type {string} */
FacilityShort;
/** @type {string} */
SourceSite;
/** @type {string} */
Supplier;
/** @type {string} */
SupplierPlural;
/** @type {string} */
UnloadVerb;
/** @type {string} */
TicketNoun;
/** @type {string} */
DayNoun;
/** @type {string} */
FleetLabel;
/** @type {string} */
PageSubtitle;
/** @type {string} */
SeasonChip;
/** @type {string} */
CampaignNoun;
/** @type {string} */
BayNoun;
/** @type {string} */
AssignTarget;
}
export class DispatchPackUnitView {
/** @param {{PackId?:string,Unit?:string,LoadQty?:number,VolumeLow?:number,VolumeHigh?:number,SeasonMultiple?:number,WeeklyFraction?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PackId;
/** @type {string} */
Unit;
/** @type {number} */
LoadQty;
/** @type {number} */
VolumeLow;
/** @type {number} */
VolumeHigh;
/** @type {number} */
SeasonMultiple;
/** @type {number} */
WeeklyFraction;
}
export class DispatchHoldView {
/** @param {{HoldId?:number,Code?:string,ScopeKind?:string,ScopeKey?:string,ScopeLabel?:string,Reason?:string,Note?:string,StartUtc?:string,EndUtc?:string,Source?:string,IncidentRef?:string,LiftedUtc?:string,LiftedBy?:string,CreatedUtc?:string,CreatedBy?:string,Status?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
HoldId;
/** @type {string} */
Code;
/** @type {string} */
ScopeKind;
/** @type {string} */
ScopeKey;
/** @type {string} */
ScopeLabel;
/** @type {string} */
Reason;
/** @type {string} */
Note;
/** @type {string} */
StartUtc;
/** @type {string} */
EndUtc;
/** @type {string} */
Source;
/** @type {string} */
IncidentRef;
/** @type {?string} */
LiftedUtc;
/** @type {string} */
LiftedBy;
/** @type {?string} */
CreatedUtc;
/** @type {string} */
CreatedBy;
/** @type {string} */
Status;
}
export class DispatchBoardIncidentView {
/** @param {{IncidentId?:number,Code?:string,Kind?:string,KindDetail?:string,Status?:string,TruckCode?:string,LoadCode?:string,TruckRecovery?:string,LoadRecovery?:string,OpenedUtc?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
IncidentId;
/** @type {string} */
Code;
/** @type {string} */
Kind;
/** @type {string} */
KindDetail;
/** @type {string} */
Status;
/** @type {string} */
TruckCode;
/** @type {string} */
LoadCode;
/** @type {string} */
TruckRecovery;
/** @type {string} */
LoadRecovery;
/** @type {string} */
OpenedUtc;
}
export class CourierMoveTarget {
/** @param {{DriverContactId?:number,Name?:string,Ok?:boolean,Why?:string,LeaveByText?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
DriverContactId;
/** @type {string} */
Name;
/** @type {boolean} */
Ok;
/** @type {string} */
Why;
/** @type {string} */
LeaveByText;
}
export class CourierVanChip {
/** @param {{Code?:string,CourierStep?:string,LevelCode?:string,LevelName?:string,Units?:number,Area?:string,DueUtc?:string,DueText?:string,Movable?:boolean,NoMoveWhy?:string,Targets?:CourierMoveTarget[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Code;
/** @type {string} */
CourierStep;
/** @type {string} */
LevelCode;
/** @type {string} */
LevelName;
/** @type {number} */
Units;
/** @type {string} */
Area;
/** @type {?string} */
DueUtc;
/** @type {string} */
DueText;
/** @type {boolean} */
Movable;
/** @type {string} */
NoMoveWhy;
/** @type {CourierMoveTarget[]} */
Targets = [];
}
export class CourierOfficeVan {
/** @param {{DriverContactId?:number,DriverCode?:string,Name?:string,Online?:boolean,Zone?:string,VehicleUnit?:string,FacilityName?:string,State?:string,LeaveByUtc?:string,LeaveByText?:string,SlackMin?:number,InVan?:number,Committed?:number,Cap?:number,CapUnit?:string,UnitMany?:string,CriticalCode?:string,DriveMin?:number,SendNote?:string,Aboard?:CourierVanChip[],Queued?:CourierVanChip[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
DriverContactId;
/** @type {string} */
DriverCode;
/** @type {string} */
Name;
/** @type {boolean} */
Online;
/** @type {string} */
Zone;
/** @type {string} */
VehicleUnit;
/** @type {string} */
FacilityName;
/** @type {string} */
State;
/** @type {?string} */
LeaveByUtc;
/** @type {string} */
LeaveByText;
/** @type {?number} */
SlackMin;
/** @type {number} */
InVan;
/** @type {number} */
Committed;
/** @type {?number} */
Cap;
/** @type {string} */
CapUnit;
/** @type {string} */
UnitMany;
/** @type {string} */
CriticalCode;
/** @type {number} */
DriveMin;
/** @type {string} */
SendNote;
/** @type {CourierVanChip[]} */
Aboard = [];
/** @type {CourierVanChip[]} */
Queued = [];
}
export class CourierHeldView {
/** @param {{Code?:string,Area?:string,Units?:number,UnitMany?:string,Miles?:number,LevelCode?:string,LevelName?:string,DueText?:string,HeldReason?:string,HeldMin?:number,Why?:string[],BestDriverContactId?:number,BestName?:string,BestLeaveByText?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Code;
/** @type {string} */
Area;
/** @type {number} */
Units;
/** @type {string} */
UnitMany;
/** @type {?number} */
Miles;
/** @type {string} */
LevelCode;
/** @type {string} */
LevelName;
/** @type {string} */
DueText;
/** @type {string} */
HeldReason;
/** @type {?number} */
HeldMin;
/** @type {string[]} */
Why = [];
/** @type {?number} */
BestDriverContactId;
/** @type {string} */
BestName;
/** @type {string} */
BestLeaveByText;
}
export class CourierVehicleOption {
/** @param {{CourierProfileId?:number,EquipmentID?:number,UnitNumber?:string,VehicleType?:string,CapacityUnit?:string,CapacityLimit?:number,IsRefrigerated?:boolean,Status?:string,Ownership?:string,OwnerContactId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CourierProfileId;
/** @type {number} */
EquipmentID;
/** @type {string} */
UnitNumber;
/** @type {string} */
VehicleType;
/** @type {string} */
CapacityUnit;
/** @type {?number} */
CapacityLimit;
/** @type {boolean} */
IsRefrigerated;
/** @type {string} */
Status;
/** @type {string} */
Ownership;
/** @type {?number} */
OwnerContactId;
}
export class CourierFacilityOption {
/** @param {{CourierFacilityID?:number,Code?:string,Name?:string,Address?:string,IntakeMin?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CourierFacilityID;
/** @type {string} */
Code;
/** @type {string} */
Name;
/** @type {string} */
Address;
/** @type {number} */
IntakeMin;
}
export class CourierProfileOption {
/** @param {{CourierProfileID?:number,Name?:string,RouteShape?:string,Enabled?:boolean,UnitOne?:string,UnitMany?:string,FacilityNoun?:string,Facilities?:CourierFacilityOption[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CourierProfileID;
/** @type {string} */
Name;
/** @type {string} */
RouteShape;
/** @type {boolean} */
Enabled;
/** @type {string} */
UnitOne;
/** @type {string} */
UnitMany;
/** @type {string} */
FacilityNoun;
/** @type {CourierFacilityOption[]} */
Facilities = [];
}
export class CourierDriverOption {
/** @param {{ContactId?:number,Code?:string,Name?:string,Online?:boolean,Zone?:string,VehicleUnit?:string,EquipmentID?:number,SentToFacility?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ContactId;
/** @type {string} */
Code;
/** @type {string} */
Name;
/** @type {boolean} */
Online;
/** @type {string} */
Zone;
/** @type {string} */
VehicleUnit;
/** @type {?number} */
EquipmentID;
/** @type {boolean} */
SentToFacility;
}
export class CourierDeskRow {
/** @param {{Code?:string,CourierProfileId?:number,FacilityName?:string,LevelCode?:string,LevelName?:string,DueUtc?:string,DueText?:string,Units?:number,UnitsFound?:number,UnitMany?:string,Fare?:number,FinalPrice?:number,TipAmount?:number,PayMode?:string,CaptureMode?:string,CustomerName?:string,Area?:string,IntakeUtc?:string,IntakeMinAgo?:number,DamageNote?:string,FinalPriceAfterCount?:boolean,NeedsPrice?:boolean,ItemCount?:number,MissingCount?:number,PhotoCount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Code;
/** @type {number} */
CourierProfileId;
/** @type {string} */
FacilityName;
/** @type {string} */
LevelCode;
/** @type {string} */
LevelName;
/** @type {?string} */
DueUtc;
/** @type {string} */
DueText;
/** @type {number} */
Units;
/** @type {?number} */
UnitsFound;
/** @type {string} */
UnitMany;
/** @type {?number} */
Fare;
/** @type {?number} */
FinalPrice;
/** @type {?number} */
TipAmount;
/** @type {string} */
PayMode;
/** @type {string} */
CaptureMode;
/** @type {string} */
CustomerName;
/** @type {string} */
Area;
/** @type {?string} */
IntakeUtc;
/** @type {?number} */
IntakeMinAgo;
/** @type {string} */
DamageNote;
/** @type {boolean} */
FinalPriceAfterCount;
/** @type {boolean} */
NeedsPrice;
/** @type {number} */
ItemCount;
/** @type {number} */
MissingCount;
/** @type {number} */
PhotoCount;
}
export class CourierOfficeView {
/** @param {{ServerUtc?:string,Vans?:CourierOfficeVan[],Held?:CourierHeldView[],Vehicles?:CourierVehicleOption[],Profiles?:CourierProfileOption[],Drivers?:CourierDriverOption[],Desk?:CourierDeskRow[],GoCount?:number,HeldCount?:number,ReadyToOffer?:number,IntakeMin?:number,FacilityNoun?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ServerUtc;
/** @type {CourierOfficeVan[]} */
Vans = [];
/** @type {CourierHeldView[]} */
Held = [];
/** @type {CourierVehicleOption[]} */
Vehicles = [];
/** @type {CourierProfileOption[]} */
Profiles = [];
/** @type {CourierDriverOption[]} */
Drivers = [];
/** @type {CourierDeskRow[]} */
Desk = [];
/** @type {number} */
GoCount;
/** @type {number} */
HeldCount;
/** @type {number} */
ReadyToOffer;
/** @type {?number} */
IntakeMin;
/** @type {string} */
FacilityNoun;
}
export class DispatchBoardView {
/** @param {{Pack?:DispatchPackConfigView,Config?:DispatchHaulConfigView,OfflineWindows?:DispatchOfflineWindowView[],Suppliers?:DispatchSupplierView[],Trucks?:DispatchTruckView[],Slots?:DispatchSlotView[],Tickets?:DispatchTicketView[],Log?:DispatchLogView[],Autopilot?:DispatchAutopilotView,Exceptions?:DispatchExceptionView[],Feed?:DispatchFeedView[],Rigs?:DispatchRigView[],Jobs?:DispatchJobView[],OdDrivers?:DispatchOdDriverView[],OdRequests?:DispatchOdRequestView[],Packs?:DispatchPackView[],PackTerms?:DispatchPackTermView[],PackUnits?:DispatchPackUnitView[],Holds?:DispatchHoldView[],Incidents?:DispatchBoardIncidentView[],Courier?:CourierOfficeView}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {DispatchPackConfigView} */
Pack;
/** @type {DispatchHaulConfigView} */
Config;
/** @type {DispatchOfflineWindowView[]} */
OfflineWindows = [];
/** @type {DispatchSupplierView[]} */
Suppliers = [];
/** @type {DispatchTruckView[]} */
Trucks = [];
/** @type {DispatchSlotView[]} */
Slots = [];
/** @type {DispatchTicketView[]} */
Tickets = [];
/** @type {DispatchLogView[]} */
Log = [];
/** @type {DispatchAutopilotView} */
Autopilot;
/** @type {DispatchExceptionView[]} */
Exceptions = [];
/** @type {DispatchFeedView[]} */
Feed = [];
/** @type {DispatchRigView[]} */
Rigs = [];
/** @type {DispatchJobView[]} */
Jobs = [];
/** @type {DispatchOdDriverView[]} */
OdDrivers = [];
/** @type {DispatchOdRequestView[]} */
OdRequests = [];
/** @type {DispatchPackView[]} */
Packs = [];
/** @type {DispatchPackTermView[]} */
PackTerms = [];
/** @type {DispatchPackUnitView[]} */
PackUnits = [];
/** @type {DispatchHoldView[]} */
Holds = [];
/** @type {DispatchBoardIncidentView[]} */
Incidents = [];
/** @type {CourierOfficeView} */
Courier;
}
export class DispatchActionResponse {
/** @param {{Board?:DispatchBoardView,Message?:string,Sent?:number,Failed?:number,TicketCode?:string,TicketNet?:number,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {DispatchBoardView} */
Board;
/** @type {string} */
Message;
/** @type {number} */
Sent;
/** @type {number} */
Failed;
/** @type {string} */
TicketCode;
/** @type {number} */
TicketNet;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class DispatchConfigRequest {
/** @param {{QueueMax?:number,DumpBays?:number,SlotCap?:number,Paused?:boolean,FeedRate?:number,Note?:string,AtMin?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
QueueMax;
/** @type {?number} */
DumpBays;
/** @type {?number} */
SlotCap;
/** @type {?boolean} */
Paused;
/** @type {?number} */
FeedRate;
/** @type {string} */
Note;
/** @type {number} */
AtMin;
}
JavaScript DispatchConfigRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /v1/dispatch/haul/config HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
QueueMax: 0,
DumpBays: 0,
SlotCap: 0,
Paused: False,
FeedRate: 0,
Note: String,
AtMin: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Board:
{
Pack:
{
PackId: String,
HasQuotas: False,
IsInverted: False,
LoadLimitMins: 0,
TicketSource: String,
PayBasis: String,
DayBoundary: String
},
Config:
{
QueueMax: 0,
DumpBays: 0,
SlotCap: 0,
Paused: False,
FeedRate: 0
},
OfflineWindows:
[
{
OfflineWindowId: 0,
FromHour: String,
ToHour: String
}
],
Suppliers:
[
{
SupplierId: 0,
Code: String,
Name: String,
Region: String,
OwnHauler: False,
SeasonAllotment: 0,
Delivered: 0,
WeekCap: 0,
WeekDelivered: 0,
SortOrder: 0,
Sites:
[
{
SiteId: 0,
SupplierId: 0,
SupplierCode: String,
Name: String,
Acres: 0,
StandingVolume: 0,
SortOrder: 0
}
]
}
],
Trucks:
[
{
TruckId: 0,
Code: String,
DriverName: String,
Phone: String,
DispatchState: String,
DispatchReason: String,
EmployerCode: String,
SupplierCode: String,
SiteName: String,
EstLoad: 0,
Stage: String,
StageSince: 0,
CycleStart: 0,
StageMinsAgo: 0,
CycleMinsAgo: 0,
Slot: String,
LoadsToday: 0,
NetToday: 0,
LastPingMins: 0,
CycleMins: String,
IsInteractive: False,
NextSupplierCode: String,
NextSiteName: String
}
],
Slots:
[
{
SlotId: 0,
Hour: String,
BaseBooked: 0,
SortOrder: 0
}
],
Tickets:
[
{
TicketId: 0,
Code: String,
TruckCode: String,
SupplierCode: String,
NetQty: 0,
TicketedAt: 0001-01-01,
TicketedMin: 0,
Source: String,
MinsAgo: 0
}
],
Log:
[
{
LogId: 0,
LoggedAt: 0001-01-01,
LoggedMin: 0,
LogText: String,
Kind: String,
MinsAgo: 0
}
],
Autopilot:
{
IsOn: False,
RuleSlot: False,
RuleRoute: False,
RuleRelease: False,
RuleTract: False,
RuleThrottle: False,
RuleOffline: False,
ThStaged: 0,
ThWait: 0,
ThBand: 0,
ThStall: 0,
ThFeed: 0
},
Exceptions:
[
{
Code: String,
Kind: String,
Severity: String,
TruckCode: String,
SupplierCode: String,
RaisedAt: 0001-01-01,
RaisedLabel: String,
MinsAgo: 0
}
],
Feed:
[
{
FeedId: 0,
EntryAt: 0001-01-01,
EntryLabel: String,
Channel: String,
Kind: String,
TruckCode: String,
SupplierCode: String,
OverrideText: String,
MinsAgo: 0
}
],
Rigs:
[
{
RigId: 0,
Code: String,
Name: String,
DriverName: String,
Phone: String,
RigType: String,
IsFree: False,
MatchRank: 0,
DispatchState: String,
DispatchReason: String
}
],
Jobs:
[
{
JobId: 0,
Code: String,
Cargo: String,
Customer: String,
CustomerPhone: String,
HoldContact: String,
HoldPhone: String,
FromLoc: String,
ToLoc: String,
Miles: 0,
WindowText: String,
Stage: String,
Rate: 0,
RequiredRig: String,
DriverLabel: String,
EtaText: String,
OfferRigIds: String,
OfferExpiresMin: 0,
OfferExpiresInMins: 0,
OfferExpired: False,
Declined: False
}
],
OdDrivers:
[
{
DriverId: 0,
Code: String,
Name: String,
Zone: String,
Phone: String,
Status: String,
Tier: String,
DistanceMi: 0,
Capabilities: String,
DispatchState: String,
DispatchReason: String
}
],
OdRequests:
[
{
RequestId: 0,
Code: String,
Address: String,
Zone: String,
Bags: 0,
Stage: String,
DriverCode: String,
Needs: String,
Note: String,
PingExpiresMin: 0,
PingExpiresInMins: 0,
TriedCodes: String,
CandidateCodes: String,
EtaText: String,
NoDriver: String
}
],
Packs:
[
{
PackId: String,
HasQuotas: False,
IsInverted: False,
LoadLimitMins: 0,
DayBoundary: String,
TicketSource: String,
PayBasis: String,
SortOrder: 0
}
],
PackTerms:
[
{
PackId: String,
Lang: String,
ModeName: String,
Facility: String,
FacilityShort: String,
SourceSite: String,
Supplier: String,
SupplierPlural: String,
UnloadVerb: String,
TicketNoun: String,
DayNoun: String,
FleetLabel: String,
PageSubtitle: String,
SeasonChip: String,
CampaignNoun: String,
BayNoun: String,
AssignTarget: String
}
],
PackUnits:
[
{
PackId: String,
Unit: String,
LoadQty: 0,
VolumeLow: 0,
VolumeHigh: 0,
SeasonMultiple: 0,
WeeklyFraction: 0
}
],
Holds:
[
{
HoldId: 0,
Code: String,
ScopeKind: String,
ScopeKey: String,
ScopeLabel: String,
Reason: String,
Note: String,
StartUtc: 0001-01-01,
EndUtc: 0001-01-01,
Source: String,
IncidentRef: String,
LiftedUtc: 0001-01-01,
LiftedBy: String,
CreatedUtc: 0001-01-01,
CreatedBy: String,
Status: String
}
],
Incidents:
[
{
IncidentId: 0,
Code: String,
Kind: String,
KindDetail: String,
Status: String,
TruckCode: String,
LoadCode: String,
TruckRecovery: String,
LoadRecovery: String,
OpenedUtc: 0001-01-01
}
],
Courier:
{
ServerUtc: 0001-01-01,
Vans:
[
{
DriverContactId: 0,
DriverCode: String,
Name: String,
Online: False,
Zone: String,
VehicleUnit: String,
FacilityName: String,
State: String,
LeaveByUtc: 0001-01-01,
LeaveByText: String,
SlackMin: 0,
InVan: 0,
Committed: 0,
Cap: 0,
CapUnit: String,
UnitMany: String,
CriticalCode: String,
DriveMin: 0,
SendNote: String,
Aboard:
[
{
Code: String,
CourierStep: String,
LevelCode: String,
LevelName: String,
Units: 0,
Area: String,
DueUtc: 0001-01-01,
DueText: String,
Movable: False,
NoMoveWhy: String,
Targets:
[
{
DriverContactId: 0,
Name: String,
Ok: False,
Why: String,
LeaveByText: String
}
]
}
],
Queued:
[
{
Code: String,
CourierStep: String,
LevelCode: String,
LevelName: String,
Units: 0,
Area: String,
DueUtc: 0001-01-01,
DueText: String,
Movable: False,
NoMoveWhy: String,
Targets:
[
{
DriverContactId: 0,
Name: String,
Ok: False,
Why: String,
LeaveByText: String
}
]
}
]
}
],
Held:
[
{
Code: String,
Area: String,
Units: 0,
UnitMany: String,
Miles: 0,
LevelCode: String,
LevelName: String,
DueText: String,
HeldReason: String,
HeldMin: 0,
Why:
[
String
],
BestDriverContactId: 0,
BestName: String,
BestLeaveByText: String
}
],
Vehicles:
[
{
CourierProfileId: 0,
EquipmentID: 0,
UnitNumber: String,
VehicleType: String,
CapacityUnit: String,
CapacityLimit: 0,
IsRefrigerated: False,
Status: String,
Ownership: String,
OwnerContactId: 0
}
],
Profiles:
[
{
CourierProfileID: 0,
Name: String,
RouteShape: String,
Enabled: False,
UnitOne: String,
UnitMany: String,
FacilityNoun: String,
Facilities:
[
{
CourierFacilityID: 0,
Code: String,
Name: String,
Address: String,
IntakeMin: 0
}
]
}
],
Drivers:
[
{
ContactId: 0,
Code: String,
Name: String,
Online: False,
Zone: String,
VehicleUnit: String,
EquipmentID: 0,
SentToFacility: False
}
],
Desk:
[
{
Code: String,
CourierProfileId: 0,
FacilityName: String,
LevelCode: String,
LevelName: String,
DueUtc: 0001-01-01,
DueText: String,
Units: 0,
UnitsFound: 0,
UnitMany: String,
Fare: 0,
FinalPrice: 0,
TipAmount: 0,
PayMode: String,
CaptureMode: String,
CustomerName: String,
Area: String,
IntakeUtc: 0001-01-01,
IntakeMinAgo: 0,
DamageNote: String,
FinalPriceAfterCount: False,
NeedsPrice: False,
ItemCount: 0,
MissingCount: 0,
PhotoCount: 0
}
],
GoCount: 0,
HeldCount: 0,
ReadyToOffer: 0,
IntakeMin: 0,
FacilityNoun: String
}
},
Message: String,
Sent: 0,
Failed: 0,
TicketCode: String,
TicketNet: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}