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

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 DispatchLaneRateSaveRequest
{
    public Lane: DispatchLaneRateView;

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

TypeScript DispatchLaneRateSaveRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchLaneRateSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Lane>
    <DispatchLaneRateID>0</DispatchLaneRateID>
    <DispatchSiteID>0</DispatchSiteID>
    <DispatchSupplierID>0</DispatchSupplierID>
    <Miles>0</Miles>
    <RatePerHour>0</RatePerHour>
    <RatePerLoad>0</RatePerLoad>
    <RatePerTon>0</RatePerTon>
    <RatePerTonMile>0</RatePerTonMile>
    <SourceLabel>String</SourceLabel>
    <SupplierName>String</SupplierName>
  </Lane>
</DispatchLaneRateSaveRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DispatchRatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Config>
    <Facility>String</Facility>
    <FuelSurchargePct>0</FuelSurchargePct>
    <HaulBasis>String</HaulBasis>
    <LoadQty>0</LoadQty>
    <OdBase>0</OdBase>
    <OdPerBag>0</OdPerBag>
    <OdPremiumUpliftPct>0</OdPremiumUpliftPct>
    <TransportEnclosedUpliftPct>0</TransportEnclosedUpliftPct>
    <TransportJobMin>0</TransportJobMin>
    <TransportPerMile>0</TransportPerMile>
    <Unit>String</Unit>
  </Config>
  <Lanes>
    <DispatchLaneRateView>
      <DispatchLaneRateID>0</DispatchLaneRateID>
      <DispatchSiteID>0</DispatchSiteID>
      <DispatchSupplierID>0</DispatchSupplierID>
      <Miles>0</Miles>
      <RatePerHour>0</RatePerHour>
      <RatePerLoad>0</RatePerLoad>
      <RatePerTon>0</RatePerTon>
      <RatePerTonMile>0</RatePerTonMile>
      <SourceLabel>String</SourceLabel>
      <SupplierName>String</SupplierName>
    </DispatchLaneRateView>
  </Lanes>
  <Plans>
    <DispatchPayPlanView>
      <Basis>String</Basis>
      <DispatchPayPlanID>0</DispatchPayPlanID>
      <Drivers>0</Drivers>
      <EffectiveDate>0001-01-01T00:00:00</EffectiveDate>
      <IsActive>false</IsActive>
      <Name>String</Name>
      <Rate>0</Rate>
      <Rate2>0</Rate2>
    </DispatchPayPlanView>
  </Plans>
  <Repriced>0</Repriced>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <StillNoPay>0</StillNoPay>
  <StillNoRevenue>0</StillNoRevenue>
  <Zones>
    <DispatchZoneRateView>
      <Base>0</Base>
      <DispatchZoneRateID>0</DispatchZoneRateID>
      <Drivers>0</Drivers>
      <PerBag>0</PerBag>
      <PremiumUpliftPct>0</PremiumUpliftPct>
      <Zone>String</Zone>
    </DispatchZoneRateView>
  </Zones>
</DispatchRatesResponse>