Trendsic Platform Service

<back to all web services

DispatchRateConfigSaveRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/dispatch/rates/config
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class DispatchRateConfigSaveRequest
{
    open var Config:DispatchRateConfigView? = null
}

open class DispatchRateConfigView
{
    open var FuelSurchargePct:BigDecimal? = null
    open var TransportPerMile:BigDecimal? = null
    open var TransportJobMin:BigDecimal? = null
    open var TransportEnclosedUpliftPct:BigDecimal? = null
    open var OdBase:BigDecimal? = null
    open var OdPerBag:BigDecimal? = null
    open var OdPremiumUpliftPct:BigDecimal? = null
    open var HaulBasis:String? = null
    open var Facility:String? = null
    open var Unit:String? = null
    open var LoadQty:BigDecimal? = null
}

open class DispatchRatesResponse
{
    open var Config:DispatchRateConfigView? = null
    open var Lanes:ArrayList<DispatchLaneRateView> = ArrayList<DispatchLaneRateView>()
    open var Zones:ArrayList<DispatchZoneRateView> = ArrayList<DispatchZoneRateView>()
    open var Plans:ArrayList<DispatchPayPlanView> = ArrayList<DispatchPayPlanView>()
    open var Repriced:Int? = null
    open var StillNoRevenue:Int? = null
    open var StillNoPay:Int? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class DispatchLaneRateView
{
    open var DispatchSiteID:Int? = null
    open var DispatchSupplierID:Int? = null
    open var SourceLabel:String? = null
    open var SupplierName:String? = null
    open var DispatchLaneRateID:Int? = null
    open var Miles:BigDecimal? = null
    open var RatePerTon:BigDecimal? = null
    open var RatePerLoad:BigDecimal? = null
    open var RatePerTonMile:BigDecimal? = null
    open var RatePerHour:BigDecimal? = null
}

open class DispatchZoneRateView
{
    open var Zone:String? = null
    open var DispatchZoneRateID:Int? = null
    open var Base:BigDecimal? = null
    open var PerBag:BigDecimal? = null
    open var PremiumUpliftPct:BigDecimal? = null
    open var Drivers:Int? = null
}

open class DispatchPayPlanView
{
    open var DispatchPayPlanID:Int? = null
    open var Name:String? = null
    open var Basis:String? = null
    open var Rate:BigDecimal? = null
    open var Rate2:BigDecimal? = null
    open var EffectiveDate:Date? = null
    open var IsActive:Boolean? = null
    open var Drivers:Int? = null
}

Kotlin DispatchRateConfigSaveRequest DTOs

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/config HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
	}
}
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
		}
	}
}