Trendsic Platform Service

<back to all web services

DispatchConfigRequest

Requires Authentication
The following routes are available for this service:
PUT,PATCH,OPTIONS/v1/dispatch/haul/config
DispatchConfigRequest Parameters:
NameParameterData TypeRequiredDescription
QueueMaxbodyint?No
DumpBaysbodyint?No
SlotCapbodyint?No
Pausedbodybool?No
FeedRatebodyint?No
NotebodystringNo
AtMinbodyintNo
DispatchActionResponse Parameters:
NameParameterData TypeRequiredDescription
BoardformDispatchBoardViewNo
MessageformstringNo
SentformintNo
FailedformintNo
TicketCodeformstringNo
TicketNetformdecimalNo
ResponseStatusformResponseStatusNo
DispatchBoardView Parameters:
NameParameterData TypeRequiredDescription
PackformDispatchPackConfigViewNo
ConfigformDispatchHaulConfigViewNo
OfflineWindowsformList<DispatchOfflineWindowView>No
SuppliersformList<DispatchSupplierView>No
TrucksformList<DispatchTruckView>No
SlotsformList<DispatchSlotView>No
TicketsformList<DispatchTicketView>No
LogformList<DispatchLogView>No
AutopilotformDispatchAutopilotViewNo
ExceptionsformList<DispatchExceptionView>No
FeedformList<DispatchFeedView>No
RigsformList<DispatchRigView>No
JobsformList<DispatchJobView>No
OdDriversformList<DispatchOdDriverView>No
OdRequestsformList<DispatchOdRequestView>No
PacksformList<DispatchPackView>No
PackTermsformList<DispatchPackTermView>No
PackUnitsformList<DispatchPackUnitView>No
HoldsformList<DispatchHoldView>No
IncidentsformList<DispatchBoardIncidentView>No
CourierformCourierOfficeViewNo
DispatchPackConfigView Parameters:
NameParameterData TypeRequiredDescription
PackIdformstringNo
HasQuotasformboolNo
IsInvertedformboolNo
LoadLimitMinsformintNo
TicketSourceformstringNo
PayBasisformstringNo
DayBoundaryformstringNo
DispatchHaulConfigView Parameters:
NameParameterData TypeRequiredDescription
QueueMaxformintNo
DumpBaysformintNo
SlotCapformintNo
PausedformboolNo
FeedRateformintNo
DispatchOfflineWindowView Parameters:
NameParameterData TypeRequiredDescription
OfflineWindowIdformintNo
FromHourformstringNo
ToHourformstringNo
DispatchSupplierView Parameters:
NameParameterData TypeRequiredDescription
SupplierIdformintNo
CodeformstringNo
NameformstringNo
RegionformstringNo
OwnHaulerformboolNo
SeasonAllotmentformdecimalNo
DeliveredformdecimalNo
WeekCapformdecimalNo
WeekDeliveredformdecimalNo
SortOrderformintNo
SitesformList<DispatchSiteView>No
DispatchSiteView Parameters:
NameParameterData TypeRequiredDescription
SiteIdformintNo
SupplierIdformintNo
SupplierCodeformstringNo
NameformstringNo
AcresformintNo
StandingVolumeformdecimalNo
SortOrderformintNo
DispatchTruckView Parameters:
NameParameterData TypeRequiredDescription
TruckIdformintNo
CodeformstringNo
DriverNameformstringNo
PhoneformstringNo
DispatchStateformstringNo
DispatchReasonformstringNo
EmployerCodeformstringNo
SupplierCodeformstringNo
SiteNameformstringNo
EstLoadformdecimalNo
StageformstringNo
StageSinceformintNo
CycleStartformint?No
StageMinsAgoformintNo
CycleMinsAgoformint?No
SlotformstringNo
LoadsTodayformintNo
NetTodayformdecimalNo
LastPingMinsformintNo
CycleMinsformstringNo
IsInteractiveformboolNo
NextSupplierCodeformstringNo
NextSiteNameformstringNo
DispatchSlotView Parameters:
NameParameterData TypeRequiredDescription
SlotIdformintNo
HourformstringNo
BaseBookedformintNo
SortOrderformintNo
DispatchTicketView Parameters:
NameParameterData TypeRequiredDescription
TicketIdformintNo
CodeformstringNo
TruckCodeformstringNo
SupplierCodeformstringNo
NetQtyformdecimalNo
TicketedAtformDateTimeNo
TicketedMinformintNo
SourceformstringNo
MinsAgoformintNo
DispatchLogView Parameters:
NameParameterData TypeRequiredDescription
LogIdformintNo
LoggedAtformDateTimeNo
LoggedMinformintNo
LogTextformstringNo
KindformstringNo
MinsAgoformintNo
DispatchAutopilotView Parameters:
NameParameterData TypeRequiredDescription
IsOnformboolNo
RuleSlotformboolNo
RuleRouteformboolNo
RuleReleaseformboolNo
RuleTractformboolNo
RuleThrottleformboolNo
RuleOfflineformboolNo
ThStagedformintNo
ThWaitformintNo
ThBandformintNo
ThStallformintNo
ThFeedformintNo
DispatchExceptionView Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
KindformstringNo
SeverityformstringNo
TruckCodeformstringNo
SupplierCodeformstringNo
RaisedAtformDateTimeNo
RaisedLabelformstringNo
MinsAgoformintNo
DispatchFeedView Parameters:
NameParameterData TypeRequiredDescription
FeedIdformintNo
EntryAtformDateTimeNo
EntryLabelformstringNo
ChannelformstringNo
KindformstringNo
TruckCodeformstringNo
SupplierCodeformstringNo
OverrideTextformstringNo
MinsAgoformintNo
DispatchRigView Parameters:
NameParameterData TypeRequiredDescription
RigIdformintNo
CodeformstringNo
NameformstringNo
DriverNameformstringNo
PhoneformstringNo
RigTypeformstringNo
IsFreeformboolNo
MatchRankformintNo
DispatchStateformstringNo
DispatchReasonformstringNo
DispatchJobView Parameters:
NameParameterData TypeRequiredDescription
JobIdformintNo
CodeformstringNo
CargoformstringNo
CustomerformstringNo
CustomerPhoneformstringNo
HoldContactformstringNo
HoldPhoneformstringNo
FromLocformstringNo
ToLocformstringNo
MilesformintNo
WindowTextformstringNo
StageformstringNo
Rateformdecimal?No
RequiredRigformstringNo
DriverLabelformstringNo
EtaTextformstringNo
OfferRigIdsformstringNo
OfferExpiresMinformint?No
OfferExpiresInMinsformint?No
OfferExpiredformboolNo
DeclinedformboolNo
DispatchOdDriverView Parameters:
NameParameterData TypeRequiredDescription
DriverIdformintNo
CodeformstringNo
NameformstringNo
ZoneformstringNo
PhoneformstringNo
StatusformstringNo
TierformstringNo
DistanceMiformdecimalNo
CapabilitiesformstringNo
DispatchStateformstringNo
DispatchReasonformstringNo
DispatchOdRequestView Parameters:
NameParameterData TypeRequiredDescription
RequestIdformintNo
CodeformstringNo
AddressformstringNo
ZoneformstringNo
BagsformintNo
StageformstringNo
DriverCodeformstringNo
NeedsformstringNo
NoteformstringNo
PingExpiresMinformint?No
PingExpiresInMinsformint?No
TriedCodesformstringNo
CandidateCodesformstringNo
EtaTextformstringNo
NoDriverformstringNo
DispatchPackView Parameters:
NameParameterData TypeRequiredDescription
PackIdformstringNo
HasQuotasformboolNo
IsInvertedformboolNo
LoadLimitMinsformintNo
DayBoundaryformstringNo
TicketSourceformstringNo
PayBasisformstringNo
SortOrderformintNo
DispatchPackTermView Parameters:
NameParameterData TypeRequiredDescription
PackIdformstringNo
LangformstringNo
ModeNameformstringNo
FacilityformstringNo
FacilityShortformstringNo
SourceSiteformstringNo
SupplierformstringNo
SupplierPluralformstringNo
UnloadVerbformstringNo
TicketNounformstringNo
DayNounformstringNo
FleetLabelformstringNo
PageSubtitleformstringNo
SeasonChipformstringNo
CampaignNounformstringNo
BayNounformstringNo
AssignTargetformstringNo
DispatchPackUnitView Parameters:
NameParameterData TypeRequiredDescription
PackIdformstringNo
UnitformstringNo
LoadQtyformdecimalNo
VolumeLowformintNo
VolumeHighformintNo
SeasonMultipleformdecimalNo
WeeklyFractionformdecimalNo
DispatchHoldView Parameters:
NameParameterData TypeRequiredDescription
HoldIdformintNo
CodeformstringNo
ScopeKindformstringNo
ScopeKeyformstringNo
ScopeLabelformstringNo
ReasonformstringNo
NoteformstringNo
StartUtcformDateTimeNo
EndUtcformDateTimeNo
SourceformstringNo
IncidentRefformstringNo
LiftedUtcformDateTime?No
LiftedByformstringNo
CreatedUtcformDateTime?No
CreatedByformstringNo
StatusformstringNo
DispatchBoardIncidentView Parameters:
NameParameterData TypeRequiredDescription
IncidentIdformintNo
CodeformstringNo
KindformstringNo
KindDetailformstringNo
StatusformstringNo
TruckCodeformstringNo
LoadCodeformstringNo
TruckRecoveryformstringNo
LoadRecoveryformstringNo
OpenedUtcformDateTimeNo
CourierOfficeView Parameters:
NameParameterData TypeRequiredDescription
ServerUtcformDateTimeNo
VansformList<CourierOfficeVan>No
HeldformList<CourierHeldView>No
VehiclesformList<CourierVehicleOption>No
ProfilesformList<CourierProfileOption>No
DriversformList<CourierDriverOption>No
DeskformList<CourierDeskRow>No
GoCountformintNo
HeldCountformintNo
ReadyToOfferformintNo
IntakeMinformint?No
FacilityNounformstringNo
CourierOfficeVan Parameters:
NameParameterData TypeRequiredDescription
DriverContactIdformintNo
DriverCodeformstringNo
NameformstringNo
OnlineformboolNo
ZoneformstringNo
VehicleUnitformstringNo
FacilityNameformstringNo
StateformstringNo
LeaveByUtcformDateTime?No
LeaveByTextformstringNo
SlackMinformint?No
InVanformintNo
CommittedformintNo
Capformdecimal?No
CapUnitformstringNo
UnitManyformstringNo
CriticalCodeformstringNo
DriveMinformintNo
SendNoteformstringNo
AboardformList<CourierVanChip>No
QueuedformList<CourierVanChip>No
CourierVanChip Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
CourierStepformstringNo
LevelCodeformstringNo
LevelNameformstringNo
UnitsformintNo
AreaformstringNo
DueUtcformDateTime?No
DueTextformstringNo
MovableformboolNo
NoMoveWhyformstringNo
TargetsformList<CourierMoveTarget>No
CourierMoveTarget Parameters:
NameParameterData TypeRequiredDescription
DriverContactIdformintNo
NameformstringNo
OkformboolNo
WhyformstringNo
LeaveByTextformstringNo
CourierHeldView Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
AreaformstringNo
UnitsformintNo
UnitManyformstringNo
Milesformdecimal?No
LevelCodeformstringNo
LevelNameformstringNo
DueTextformstringNo
HeldReasonformstringNo
HeldMinformint?No
WhyformList<string>No
BestDriverContactIdformint?No
BestNameformstringNo
BestLeaveByTextformstringNo
CourierVehicleOption Parameters:
NameParameterData TypeRequiredDescription
CourierProfileIdformintNo
EquipmentIDformintNo
UnitNumberformstringNo
VehicleTypeformstringNo
CapacityUnitformstringNo
CapacityLimitformdecimal?No
IsRefrigeratedformboolNo
StatusformstringNo
OwnershipformstringNo
OwnerContactIdformint?No
CourierProfileOption Parameters:
NameParameterData TypeRequiredDescription
CourierProfileIDformintNo
NameformstringNo
RouteShapeformstringNo
EnabledformboolNo
UnitOneformstringNo
UnitManyformstringNo
FacilityNounformstringNo
FacilitiesformList<CourierFacilityOption>No
CourierFacilityOption Parameters:
NameParameterData TypeRequiredDescription
CourierFacilityIDformintNo
CodeformstringNo
NameformstringNo
AddressformstringNo
IntakeMinformintNo
CourierDriverOption Parameters:
NameParameterData TypeRequiredDescription
ContactIdformintNo
CodeformstringNo
NameformstringNo
OnlineformboolNo
ZoneformstringNo
VehicleUnitformstringNo
EquipmentIDformint?No
SentToFacilityformboolNo
CourierDeskRow Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
CourierProfileIdformintNo
FacilityNameformstringNo
LevelCodeformstringNo
LevelNameformstringNo
DueUtcformDateTime?No
DueTextformstringNo
UnitsformintNo
UnitsFoundformint?No
UnitManyformstringNo
Fareformdecimal?No
FinalPriceformdecimal?No
TipAmountformdecimal?No
PayModeformstringNo
CaptureModeformstringNo
CustomerNameformstringNo
AreaformstringNo
IntakeUtcformDateTime?No
IntakeMinAgoformint?No
DamageNoteformstringNo
FinalPriceAfterCountformboolNo
NeedsPriceformboolNo
ItemCountformintNo
MissingCountformintNo
PhotoCountformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
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-01T00:00:00.0000000","TicketedMin":0,"Source":"String","MinsAgo":0}],"Log":[{"LogId":0,"LoggedAt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","RaisedLabel":"String","MinsAgo":0}],"Feed":[{"FeedId":0,"EntryAt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","EndUtc":"0001-01-01T00:00:00.0000000","Source":"String","IncidentRef":"String","LiftedUtc":"0001-01-01T00:00:00.0000000","LiftedBy":"String","CreatedUtc":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000"}],"Courier":{"ServerUtc":"0001-01-01T00:00:00.0000000","Vans":[{"DriverContactId":0,"DriverCode":"String","Name":"String","Online":false,"Zone":"String","VehicleUnit":"String","FacilityName":"String","State":"String","LeaveByUtc":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000","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"}}}