Trendsic Platform Service

DispatchJobQuoteRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/jobs/{Code}/quote

**DispatchJobQuoteRequest** Parameters:
Name	Parameter	Data Type	Required
Code	path	string	No
Rate	body	decimal	No
AtMin	body	int	No

**DispatchActionResponse** Parameters:
Name	Parameter	Data Type	Required
Board	form	DispatchBoardView	No
Message	form	string	No
Sent	form	int	No
Failed	form	int	No
TicketCode	form	string	No
TicketNet	form	decimal	No
ResponseStatus	form	ResponseStatus	No

**DispatchBoardView** Parameters:
Name	Parameter	Data Type	Required
Pack	form	DispatchPackConfigView	No
Config	form	DispatchHaulConfigView	No
OfflineWindows	form	List<DispatchOfflineWindowView>	No
Suppliers	form	List<DispatchSupplierView>	No
Trucks	form	List<DispatchTruckView>	No
Slots	form	List<DispatchSlotView>	No
Tickets	form	List<DispatchTicketView>	No
Log	form	List<DispatchLogView>	No
Autopilot	form	DispatchAutopilotView	No
Exceptions	form	List<DispatchExceptionView>	No
Feed	form	List<DispatchFeedView>	No
Rigs	form	List<DispatchRigView>	No
Jobs	form	List<DispatchJobView>	No
OdDrivers	form	List<DispatchOdDriverView>	No
OdRequests	form	List<DispatchOdRequestView>	No
Packs	form	List<DispatchPackView>	No
PackTerms	form	List<DispatchPackTermView>	No
PackUnits	form	List<DispatchPackUnitView>	No

**DispatchPackConfigView** Parameters:
Name	Parameter	Data Type	Required
PackId	form	string	No
HasQuotas	form	bool	No
IsInverted	form	bool	No
LoadLimitMins	form	int	No
TicketSource	form	string	No
PayBasis	form	string	No
DayBoundary	form	string	No

**DispatchHaulConfigView** Parameters:
Name	Parameter	Data Type	Required
QueueMax	form	int	No
DumpBays	form	int	No
SlotCap	form	int	No
Paused	form	bool	No
FeedRate	form	int	No

**DispatchOfflineWindowView** Parameters:
Name	Parameter	Data Type	Required
OfflineWindowId	form	int	No
FromHour	form	string	No
ToHour	form	string	No

**DispatchSupplierView** Parameters:
Name	Parameter	Data Type	Required
SupplierId	form	int	No
Code	form	string	No
Name	form	string	No
Region	form	string	No
OwnHauler	form	bool	No
SeasonAllotment	form	decimal	No
Delivered	form	decimal	No
WeekCap	form	decimal	No
WeekDelivered	form	decimal	No
SortOrder	form	int	No
Sites	form	List<DispatchSiteView>	No

**DispatchSiteView** Parameters:
Name	Parameter	Data Type	Required
SiteId	form	int	No
SupplierId	form	int	No
SupplierCode	form	string	No
Name	form	string	No
Acres	form	int	No
StandingVolume	form	decimal	No
SortOrder	form	int	No

**DispatchTruckView** Parameters:
Name	Parameter	Data Type	Required
TruckId	form	int	No
Code	form	string	No
DriverName	form	string	No
Phone	form	string	No
EmployerCode	form	string	No
SupplierCode	form	string	No
SiteName	form	string	No
EstLoad	form	decimal	No
Stage	form	string	No
StageSince	form	int	No
CycleStart	form	int?	No
StageMinsAgo	form	int	No
CycleMinsAgo	form	int?	No
Slot	form	string	No
LoadsToday	form	int	No
NetToday	form	decimal	No
LastPingMins	form	int	No
CycleMins	form	string	No
IsInteractive	form	bool	No
NextSupplierCode	form	string	No
NextSiteName	form	string	No

**DispatchSlotView** Parameters:
Name	Parameter	Data Type	Required
SlotId	form	int	No
Hour	form	string	No
BaseBooked	form	int	No
SortOrder	form	int	No

**DispatchTicketView** Parameters:
Name	Parameter	Data Type	Required
TicketId	form	int	No
Code	form	string	No
TruckCode	form	string	No
SupplierCode	form	string	No
NetQty	form	decimal	No
TicketedAt	form	DateTime	No
TicketedMin	form	int	No
Source	form	string	No
MinsAgo	form	int	No

**DispatchLogView** Parameters:
Name	Parameter	Data Type	Required
LogId	form	int	No
LoggedAt	form	DateTime	No
LoggedMin	form	int	No
LogText	form	string	No
Kind	form	string	No
MinsAgo	form	int	No

**DispatchAutopilotView** Parameters:
Name	Parameter	Data Type	Required
IsOn	form	bool	No
RuleSlot	form	bool	No
RuleRoute	form	bool	No
RuleRelease	form	bool	No
RuleTract	form	bool	No
RuleThrottle	form	bool	No
RuleOffline	form	bool	No
ThStaged	form	int	No
ThWait	form	int	No
ThBand	form	int	No
ThStall	form	int	No
ThFeed	form	int	No

**DispatchExceptionView** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Kind	form	string	No
Severity	form	string	No
TruckCode	form	string	No
SupplierCode	form	string	No
RaisedAt	form	DateTime	No
RaisedLabel	form	string	No
MinsAgo	form	int	No

**DispatchFeedView** Parameters:
Name	Parameter	Data Type	Required
FeedId	form	int	No
EntryAt	form	DateTime	No
EntryLabel	form	string	No
Channel	form	string	No
Kind	form	string	No
TruckCode	form	string	No
SupplierCode	form	string	No
OverrideText	form	string	No
MinsAgo	form	int	No

**DispatchRigView** Parameters:
Name	Parameter	Data Type	Required
RigId	form	int	No
Code	form	string	No
Name	form	string	No
DriverName	form	string	No
Phone	form	string	No
RigType	form	string	No
IsFree	form	bool	No
MatchRank	form	int	No

**DispatchJobView** Parameters:
Name	Parameter	Data Type	Required
JobId	form	int	No
Code	form	string	No
Cargo	form	string	No
Customer	form	string	No
CustomerPhone	form	string	No
HoldContact	form	string	No
HoldPhone	form	string	No
FromLoc	form	string	No
ToLoc	form	string	No
Miles	form	int	No
WindowText	form	string	No
Stage	form	string	No
Rate	form	decimal?	No
RequiredRig	form	string	No
DriverLabel	form	string	No
EtaText	form	string	No
OfferRigIds	form	string	No
OfferExpiresMin	form	int?	No
OfferExpired	form	bool	No
Declined	form	bool	No

**DispatchOdDriverView** Parameters:
Name	Parameter	Data Type	Required
DriverId	form	int	No
Code	form	string	No
Name	form	string	No
Zone	form	string	No
Phone	form	string	No
Status	form	string	No
Tier	form	string	No
DistanceMi	form	decimal	No
Capabilities	form	string	No

**DispatchOdRequestView** Parameters:
Name	Parameter	Data Type	Required
RequestId	form	int	No
Code	form	string	No
Address	form	string	No
Zone	form	string	No
Bags	form	int	No
Stage	form	string	No
DriverCode	form	string	No
Needs	form	string	No
Note	form	string	No
PingExpiresMin	form	int?	No
TriedCodes	form	string	No
CandidateCodes	form	string	No
EtaText	form	string	No
NoDriver	form	string	No

**DispatchPackView** Parameters:
Name	Parameter	Data Type	Required
PackId	form	string	No
HasQuotas	form	bool	No
IsInverted	form	bool	No
LoadLimitMins	form	int	No
DayBoundary	form	string	No
TicketSource	form	string	No
PayBasis	form	string	No
SortOrder	form	int	No

**DispatchPackTermView** Parameters:
Name	Parameter	Data Type	Required
PackId	form	string	No
Lang	form	string	No
ModeName	form	string	No
Facility	form	string	No
FacilityShort	form	string	No
SourceSite	form	string	No
Supplier	form	string	No
SupplierPlural	form	string	No
UnloadVerb	form	string	No
TicketNoun	form	string	No
DayNoun	form	string	No
FleetLabel	form	string	No
PageSubtitle	form	string	No
SeasonChip	form	string	No
CampaignNoun	form	string	No
BayNoun	form	string	No
AssignTarget	form	string	No

**DispatchPackUnitView** Parameters:
Name	Parameter	Data Type	Required
PackId	form	string	No
Unit	form	string	No
LoadQty	form	decimal	No
VolumeLow	form	int	No
VolumeHigh	form	int	No
SeasonMultiple	form	decimal	No
WeeklyFraction	form	decimal	No

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{
	Code: String,
	Rate: 0,
	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,
				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
			}
		],
		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,
				OfferExpired: False,
				Declined: False
			}
		],
		OdDrivers: 
		[
			{
				DriverId: 0,
				Code: String,
				Name: String,
				Zone: String,
				Phone: String,
				Status: String,
				Tier: String,
				DistanceMi: 0,
				Capabilities: String
			}
		],
		OdRequests: 
		[
			{
				RequestId: 0,
				Code: String,
				Address: String,
				Zone: String,
				Bags: 0,
				Stage: String,
				DriverCode: String,
				Needs: String,
				Note: String,
				PingExpiresMin: 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
			}
		]
	},
	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
		}
	}
}