Trendsic Platform Service

<back to all web services

DispatchLaneRateSaveRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/dispatch/rates/lane
DispatchLaneRateSaveRequest Parameters:
NameParameterData TypeRequiredDescription
LanebodyDispatchLaneRateViewNo
DispatchLaneRateView Parameters:
NameParameterData TypeRequiredDescription
DispatchSiteIDformint?No
DispatchSupplierIDformint?No
SourceLabelformstringNo
SupplierNameformstringNo
DispatchLaneRateIDformint?No
Milesformdecimal?No
RatePerTonformdecimal?No
RatePerLoadformdecimal?No
RatePerTonMileformdecimal?No
RatePerHourformdecimal?No
DispatchRatesResponse Parameters:
NameParameterData TypeRequiredDescription
ConfigformDispatchRateConfigViewNo
LanesformList<DispatchLaneRateView>No
ZonesformList<DispatchZoneRateView>No
PlansformList<DispatchPayPlanView>No
Repricedformint?No
StillNoRevenueformint?No
StillNoPayformint?No
ResponseStatusformResponseStatusNo
DispatchRateConfigView Parameters:
NameParameterData TypeRequiredDescription
FuelSurchargePctformdecimalNo
TransportPerMileformdecimalNo
TransportJobMinformdecimalNo
TransportEnclosedUpliftPctformdecimalNo
OdBaseformdecimalNo
OdPerBagformdecimalNo
OdPremiumUpliftPctformdecimalNo
HaulBasisformstringNo
FacilityformstringNo
UnitformstringNo
LoadQtyformdecimalNo
DispatchZoneRateView Parameters:
NameParameterData TypeRequiredDescription
ZoneformstringNo
DispatchZoneRateIDformint?No
Baseformdecimal?No
PerBagformdecimal?No
PremiumUpliftPctformdecimal?No
DriversformintNo
DispatchPayPlanView Parameters:
NameParameterData TypeRequiredDescription
DispatchPayPlanIDformintNo
NameformstringNo
BasisformstringNo
RateformdecimalNo
Rate2formdecimal?No
EffectiveDateformDateTime?No
IsActiveformboolNo
DriversformintNo

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.

PUT /v1/dispatch/rates/lane HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Lane: 
	{
		DispatchSiteID: 0,
		DispatchSupplierID: 0,
		SourceLabel: String,
		SupplierName: String,
		DispatchLaneRateID: 0,
		Miles: 0,
		RatePerTon: 0,
		RatePerLoad: 0,
		RatePerTonMile: 0,
		RatePerHour: 0
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Config: 
	{
		FuelSurchargePct: 0,
		TransportPerMile: 0,
		TransportJobMin: 0,
		TransportEnclosedUpliftPct: 0,
		OdBase: 0,
		OdPerBag: 0,
		OdPremiumUpliftPct: 0,
		HaulBasis: String,
		Facility: String,
		Unit: String,
		LoadQty: 0
	},
	Lanes: 
	[
		{
			DispatchSiteID: 0,
			DispatchSupplierID: 0,
			SourceLabel: String,
			SupplierName: String,
			DispatchLaneRateID: 0,
			Miles: 0,
			RatePerTon: 0,
			RatePerLoad: 0,
			RatePerTonMile: 0,
			RatePerHour: 0
		}
	],
	Zones: 
	[
		{
			Zone: String,
			DispatchZoneRateID: 0,
			Base: 0,
			PerBag: 0,
			PremiumUpliftPct: 0,
			Drivers: 0
		}
	],
	Plans: 
	[
		{
			DispatchPayPlanID: 0,
			Name: String,
			Basis: String,
			Rate: 0,
			Rate2: 0,
			EffectiveDate: 0001-01-01,
			IsActive: False,
			Drivers: 0
		}
	],
	Repriced: 0,
	StillNoRevenue: 0,
	StillNoPay: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}