Trendsic Platform Service

DispatchRatesRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dispatch/rates

import Foundation
import ServiceStack

public class DispatchRatesRequest : Codable
{
    required public init(){}
}

public class DispatchRatesResponse : Codable
{
    public var config:DispatchRateConfigView
    public var lanes:[DispatchLaneRateView] = []
    public var zones:[DispatchZoneRateView] = []
    public var plans:[DispatchPayPlanView] = []
    public var repriced:Int?
    public var stillNoRevenue:Int?
    public var stillNoPay:Int?
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class DispatchRateConfigView : Codable
{
    public var fuelSurchargePct:Double
    public var transportPerMile:Double
    public var transportJobMin:Double
    public var transportEnclosedUpliftPct:Double
    public var odBase:Double
    public var odPerBag:Double
    public var odPremiumUpliftPct:Double
    public var haulBasis:String
    public var facility:String
    public var unit:String
    public var loadQty:Double

    required public init(){}
}

public class DispatchLaneRateView : Codable
{
    public var dispatchSiteID:Int?
    public var dispatchSupplierID:Int?
    public var sourceLabel:String
    public var supplierName:String
    public var dispatchLaneRateID:Int?
    public var miles:Double?
    public var ratePerTon:Double?
    public var ratePerLoad:Double?
    public var ratePerTonMile:Double?
    public var ratePerHour:Double?

    required public init(){}
}

public class DispatchZoneRateView : Codable
{
    public var zone:String
    public var dispatchZoneRateID:Int?
    public var base:Double?
    public var perBag:Double?
    public var premiumUpliftPct:Double?
    public var drivers:Int

    required public init(){}
}

public class DispatchPayPlanView : Codable
{
    public var dispatchPayPlanID:Int
    public var name:String
    public var basis:String
    public var rate:Double
    public var rate2:Double?
    public var effectiveDate:Date?
    public var isActive:Bool
    public var drivers:Int

    required public init(){}
}

Swift DispatchRatesRequest 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.

GET /v1/dispatch/rates HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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>