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

export class DispatchRateConfigView
{
    public FuelSurchargePct: number;
    public TransportPerMile: number;
    public TransportJobMin: number;
    public TransportEnclosedUpliftPct: number;
    public OdBase: number;
    public OdPerBag: number;
    public OdPremiumUpliftPct: number;
    public HaulBasis: string;
    public Facility: string;
    public Unit: string;
    public LoadQty: number;

    public constructor(init?: Partial<DispatchRateConfigView>) { (Object as any).assign(this, init); }
}

export class DispatchLaneRateView
{
    public DispatchSiteID?: number;
    public DispatchSupplierID?: number;
    public SourceLabel: string;
    public SupplierName: string;
    public DispatchLaneRateID?: number;
    public Miles?: number;
    public RatePerTon?: number;
    public RatePerLoad?: number;
    public RatePerTonMile?: number;
    public RatePerHour?: number;

    public constructor(init?: Partial<DispatchLaneRateView>) { (Object as any).assign(this, init); }
}

export class DispatchZoneRateView
{
    public Zone: string;
    public DispatchZoneRateID?: number;
    public Base?: number;
    public PerBag?: number;
    public PremiumUpliftPct?: number;
    public Drivers: number;

    public constructor(init?: Partial<DispatchZoneRateView>) { (Object as any).assign(this, init); }
}

export class DispatchPayPlanView
{
    public DispatchPayPlanID: number;
    public Name: string;
    public Basis: string;
    public Rate: number;
    public Rate2?: number;
    public EffectiveDate?: string;
    public IsActive: boolean;
    public Drivers: number;

    public constructor(init?: Partial<DispatchPayPlanView>) { (Object as any).assign(this, init); }
}

export class DispatchRatesResponse
{
    public Config: DispatchRateConfigView;
    public Lanes: DispatchLaneRateView[] = [];
    public Zones: DispatchZoneRateView[] = [];
    public Plans: DispatchPayPlanView[] = [];
    public Repriced?: number;
    public StillNoRevenue?: number;
    public StillNoPay?: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DispatchRatesResponse>) { (Object as any).assign(this, init); }
}

export class DispatchRateConfigSaveRequest
{
    public Config: DispatchRateConfigView;

    public constructor(init?: Partial<DispatchRateConfigSaveRequest>) { (Object as any).assign(this, init); }
}

TypeScript DispatchRateConfigSaveRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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-01T00:00:00.0000000","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"}}}