Trendsic Platform Service

<back to all web services

DispatchPayPlanSaveRequest

"use strict";
export class DispatchRateConfigView {
    /** @param {{FuelSurchargePct?:number,TransportPerMile?:number,TransportJobMin?:number,TransportEnclosedUpliftPct?:number,OdBase?:number,OdPerBag?:number,OdPremiumUpliftPct?:number,HaulBasis?:string,Facility?:string,Unit?:string,LoadQty?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    FuelSurchargePct;
    /** @type {number} */
    TransportPerMile;
    /** @type {number} */
    TransportJobMin;
    /** @type {number} */
    TransportEnclosedUpliftPct;
    /** @type {number} */
    OdBase;
    /** @type {number} */
    OdPerBag;
    /** @type {number} */
    OdPremiumUpliftPct;
    /** @type {string} */
    HaulBasis;
    /** @type {string} */
    Facility;
    /** @type {string} */
    Unit;
    /** @type {number} */
    LoadQty;
}
export class DispatchLaneRateView {
    /** @param {{DispatchSiteID?:number,DispatchSupplierID?:number,SourceLabel?:string,SupplierName?:string,DispatchLaneRateID?:number,Miles?:number,RatePerTon?:number,RatePerLoad?:number,RatePerTonMile?:number,RatePerHour?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    DispatchSiteID;
    /** @type {?number} */
    DispatchSupplierID;
    /** @type {string} */
    SourceLabel;
    /** @type {string} */
    SupplierName;
    /** @type {?number} */
    DispatchLaneRateID;
    /** @type {?number} */
    Miles;
    /** @type {?number} */
    RatePerTon;
    /** @type {?number} */
    RatePerLoad;
    /** @type {?number} */
    RatePerTonMile;
    /** @type {?number} */
    RatePerHour;
}
export class DispatchZoneRateView {
    /** @param {{Zone?:string,DispatchZoneRateID?:number,Base?:number,PerBag?:number,PremiumUpliftPct?:number,Drivers?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Zone;
    /** @type {?number} */
    DispatchZoneRateID;
    /** @type {?number} */
    Base;
    /** @type {?number} */
    PerBag;
    /** @type {?number} */
    PremiumUpliftPct;
    /** @type {number} */
    Drivers;
}
export class DispatchPayPlanView {
    /** @param {{DispatchPayPlanID?:number,Name?:string,Basis?:string,Rate?:number,Rate2?:number,EffectiveDate?:string,IsActive?:boolean,Drivers?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DispatchPayPlanID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Basis;
    /** @type {number} */
    Rate;
    /** @type {?number} */
    Rate2;
    /** @type {?string} */
    EffectiveDate;
    /** @type {boolean} */
    IsActive;
    /** @type {number} */
    Drivers;
}
export class DispatchRatesResponse {
    /** @param {{Config?:DispatchRateConfigView,Lanes?:DispatchLaneRateView[],Zones?:DispatchZoneRateView[],Plans?:DispatchPayPlanView[],Repriced?:number,StillNoRevenue?:number,StillNoPay?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DispatchRateConfigView} */
    Config;
    /** @type {DispatchLaneRateView[]} */
    Lanes = [];
    /** @type {DispatchZoneRateView[]} */
    Zones = [];
    /** @type {DispatchPayPlanView[]} */
    Plans = [];
    /** @type {?number} */
    Repriced;
    /** @type {?number} */
    StillNoRevenue;
    /** @type {?number} */
    StillNoPay;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DispatchPayPlanSaveRequest {
    /** @param {{Plan?:DispatchPayPlanView}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DispatchPayPlanView} */
    Plan;
}

JavaScript DispatchPayPlanSaveRequest DTOs

PUT /v1/dispatch/rates/plan HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchPayPlanSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Plan>
    <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>
  </Plan>
</DispatchPayPlanSaveRequest>

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>